diff --git a/.gitattributes b/.gitattributes index 272dbf0d..974726bb 100644 --- a/.gitattributes +++ b/.gitattributes @@ -4,3 +4,4 @@ # api/) isn't buried under noisy regenerated MDX/JSON. docs/bitrise-api/api-reference/** linguist-generated=true docs/bitrise-rde-api/api-reference/** linguist-generated=true +docs/release-management-api/**/api-reference/** linguist-generated=true diff --git a/.github/workflows/sync-api-references.yml b/.github/workflows/sync-api-references.yml index 47646710..2a95d708 100644 --- a/.github/workflows/sync-api-references.yml +++ b/.github/workflows/sync-api-references.yml @@ -1,13 +1,14 @@ name: Sync API references -# Keeps the generated API references (Bitrise CI + RDE) in sync with their -# hosted OpenAPI specs. Runs nightly and on demand ("Run workflow"). For each -# spec, when the hosted spec has actually changed, it regenerates that one -# reference and opens a PR for review — it never commits to main directly. +# Keeps the generated API references (Bitrise CI, RDE, and the four Release +# Management sub-APIs) in sync with their hosted OpenAPI specs. Runs nightly +# and on demand ("Run workflow"). For each spec, when the hosted spec has +# actually changed, it regenerates that one reference and opens a PR for +# review — it never commits to main directly. # -# Each spec runs as its own matrix job → its own PR, so the two products stay +# Each spec runs as its own matrix job → its own PR, so the products stay # independent (separate review, separate branches, one host being down doesn't -# block the other). +# block the others). on: schedule: - cron: '0 6 * * *' # 06:00 UTC daily @@ -46,6 +47,42 @@ jobs: api/bitrise-rde.json scripts/rde_spec_sync_state.json docs/bitrise-rde-api/api-reference + - name: Release Management Apps + spec: bitriseRMApps + sync_script: scripts/sync_rm_apps_spec.py + branch: auto/rm-apps-api-sync + title: 'docs: sync Release Management Apps API reference from updated spec' + paths: | + api/bitrise-rm-apps.json + scripts/rm_apps_spec_sync_state.json + docs/release-management-api/apps/api-reference + - name: Release Management Store Releases + spec: bitriseRMStoreReleases + sync_script: scripts/sync_rm_store_releases_spec.py + branch: auto/rm-store-releases-api-sync + title: 'docs: sync Release Management Store Releases API reference from updated spec' + paths: | + api/bitrise-rm-store-releases.json + scripts/rm_store_releases_spec_sync_state.json + docs/release-management-api/store-releases/api-reference + - name: Release Management Code Push + spec: bitriseRMCodePush + sync_script: scripts/sync_rm_code_push_spec.py + branch: auto/rm-code-push-api-sync + title: 'docs: sync Release Management Code Push API reference from updated spec' + paths: | + api/bitrise-rm-code-push.json + scripts/rm_code_push_spec_sync_state.json + docs/release-management-api/code-push/api-reference + - name: Release Management Build Distributions + spec: bitriseRMBuildDistributions + sync_script: scripts/sync_rm_build_distributions_spec.py + branch: auto/rm-build-distributions-api-sync + title: 'docs: sync Release Management Build Distributions API reference from updated spec' + paths: | + api/bitrise-rm-build-distributions.json + scripts/rm_build_distributions_spec_sync_state.json + docs/release-management-api/build-distributions/api-reference steps: - uses: actions/checkout@v4 diff --git a/api/bitrise-rm-apps.json b/api/bitrise-rm-apps.json new file mode 100644 index 00000000..e5b77dcd --- /dev/null +++ b/api/bitrise-rm-apps.json @@ -0,0 +1 @@ +{"openapi":"3.0.1","info":{"title":"Release Management API","version":"v2.1","description":"**Looking for the old API?** You can find it here: V1 API spec\n\nThe old API will be deprecated on February 1st 2027. Make sure that you have migrated to the new API before then.\n\nView the V1 → V2 Migration Guide"},"externalDocs":{"description":"API Changelog (json format)","url":"https://storage.googleapis.com/bitrise-release-management-public-api-docs/changelog_v2_apps.json"},"paths":{"/":{"get":{"summary":"Gets a list of apps","description":"Gives back a paginated list of apps your user has access to for the workspace specified based on given filters.","operationId":"ListApps","security":[{"token":[]}],"tags":["Apps"],"parameters":[{"name":"workspace_slug","in":"query","required":true,"schema":{"type":"string"}},{"name":"project_id","in":"query","required":false,"description":"Specifies which Bitrise Project you want to get associated apps for","schema":{"type":"string"}},{"name":"platform","in":"query","schema":{"enum":["ios","android"],"type":"string"},"required":false,"description":"Filter for a specific mobile platform between your apps"},{"name":"search","in":"query","required":false,"description":"Search by bundle ID (for iOS), package name (for Android), or app title. (case sensitive)","schema":{"type":"string"}},{"name":"items_per_page","in":"query","required":false,"schema":{"default":10,"maximum":50,"minimum":1,"type":"integer"},"description":"Specifies the maximum number of apps returned per request"},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer"},"description":"Specifies which page should be returned from the whole result set in a paginated scenario"}],"responses":{"200":{"description":"List Apps","content":{"application/json":{"examples":{"200 - List Apps":{"value":{"items":[{"id":"aca7efd3-edf7-4a3f-bfd5-3a4bb58a0335","created_at":"2025-02-11T09:26:01.000Z","platform":"android","project_id":"23c9f973-6b65-4aca-945b-a6eb4a0a9913","workspace_slug":"workspace-slug","icon_id":null,"icon_url":null,"app_name":"Test Android App","current_user_release_management_admin":true,"framework":null,"latest_version":"2.0.5","latest_version_date":"2025-01-29T09:26:01.000Z","latest_build_version":null,"latest_build_version_code":null,"license":"basic","project_title":"Awesome project","store_app_id":"io.bitrise.test","store_connected":true,"store_credential_id":null},{"id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","created_at":"2025-02-11T09:26:01.000Z","platform":"android","project_id":"23c9f973-6b65-4aca-945b-a6eb4a0a9913","workspace_slug":"workspace-slug","icon_id":"dd6fadd2-6e4b-4bda-b6e2-aa319cdc89cd","icon_url":"https://storage.googleapis.com/rm-public-assets-storage/apps/f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de/app_icon/dd6fadd2-6e4b-4bda-b6e2-aa319cdc89cd/icon.png","app_name":"Test Android App","current_user_release_management_admin":true,"framework":null,"latest_version":"1.1.3","latest_version_date":"2025-02-10T09:26:01.000Z","latest_build_version":null,"latest_build_version_code":null,"license":"basic","project_title":"Awesome project","store_app_id":"io.bitrise.test","store_connected":true,"store_credential_id":null}],"pagination":{"current_page":1,"items_per_page":10,"total_count":2},"counts":{"total":2,"with_basic_license":2,"with_standard_license":0}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Not found","content":{"application/json":{"examples":{"404 - Not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"post":{"summary":"Creates an app","description":"Creates an app for the workspace.","operationId":"CreateApp","security":[{"token":[]}],"tags":["Apps"],"parameters":[],"responses":{"201":{"description":"The created app with default framework","content":{"application/json":{"examples":{"201 - The created app":{"value":{"id":"50590a63-799c-4bc7-99e2-c3b2363b22d1","created_at":"2025-02-11T09:26:01.000Z","platform":"android","project_id":"23c9f973-6b65-4aca-945b-a6eb4a0a9913","workspace_slug":"workspace-slug","icon_id":null,"icon_url":null,"app_name":"My test app","current_user_release_management_admin":false,"framework":"react_native","latest_version":null,"latest_version_date":null,"latest_build_version":"","latest_build_version_code":"","license":"basic","store_app_id":"android.app.name","store_connected":true,"store_credential_id":null}},"201 - The manually created app":{"value":{"id":"50590a63-799c-4bc7-99e2-c3b2363b22d1","created_at":"2025-02-11T09:26:01.000Z","platform":"android","project_id":"23c9f973-6b65-4aca-945b-a6eb4a0a9913","workspace_slug":"workspace-slug","icon_id":null,"icon_url":null,"app_name":"Android App","current_user_release_management_admin":false,"framework":"react_native","latest_version":null,"latest_version_date":null,"latest_build_version":"","latest_build_version_code":"","license":"basic","store_app_id":"android.app.name","store_connected":false,"store_credential_id":null}},"201 - The created app with default framework":{"value":{"id":"50590a63-799c-4bc7-99e2-c3b2363b22d1","created_at":"2025-02-11T09:26:01.000Z","platform":"android","project_id":"23c9f973-6b65-4aca-945b-a6eb4a0a9913","workspace_slug":"workspace-slug","icon_id":null,"icon_url":null,"app_name":"My test app","current_user_release_management_admin":false,"framework":"other","latest_version":null,"latest_version_date":null,"latest_build_version":"","latest_build_version_code":"","license":"basic","store_app_id":"android.app.name","store_connected":true,"store_credential_id":null}}}}}},"400":{"description":"Parameter missing","content":{"application/json":{"examples":{"400 - Validation error":{"value":{"code":"ERR_INVALID_PLATFORM","message":"The given platform is invalid. Valid platforms are: \"ios\", \"android\""}},"400 - Invalid framework":{"value":{"code":"ERR_VALIDATION","message":"Validation failed: Framework is not included in the list","details":{"framework":["is not included in the list"]}}},"400 - Invalid store credential id":{"value":{"code":"ERR_INVALID_STORE_CREDENTIAL_ID","message":"The given store_credential_id is invalid."}},"400 - when parameters are missing with automatic connection":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: platform"}},"400 - when parameters are missing with manual connection":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: store_app_name"}}}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"examples":{"422 - Unprocessable entity":{"value":{"code":"ERR_MISSING_DATA","message":"You need an active store connection for connecting your app."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"An uuidV4 identifier for your new app"},"manual_connection":{"description":"If set to true it indicates a manual connection (bypassing using store api keys) and requires giving \"store_app_name\" as well. This can be especially useful for enterprise apps.","type":"boolean"},"platform":{"type":"string","description":"The mobile platform of your app","enum":["ios","android"]},"project_id":{"type":"string"},"store_app_id":{"description":"The store identifier for your app. \n- In case of iOS platform it is the bundle id. Check the [property description](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleidentifier).\n- In case of Android platform it is the package name. Check the [documentation](https://developer.android.com/build/configure-app-module#set_the_application_id).","type":"string"},"store_app_name":{"description":"If you have no active app store API keys added on Bitrise, you can decide to add your app manually by giving the app's name as well while indicating manual connection with the similarly named boolean flag.","type":"string"},"store_credential_id":{"description":"If you have credentials added on Bitrise, you can decide to select one for your app. \n- In case of iOS platform it will be an Apple API credential id.\n- In case of Android platform it will be a Google Service credential id.","type":"string"},"framework":{"description":"The framework used to build the app. Defaults to 'other' if not provided.","type":"string","enum":["flutter","react_native","kotlin_multiplatform","other","native_ios","native_android"]},"workspace_slug":{"type":"string"}},"required":["platform","store_app_id","workspace_slug"]}}}}}},"/apple-app-store/app-versions":{"post":{"summary":"Creates an App Store review version","description":"Creates an App Store version with the specified version_string, which can be used to submit for App Store review. - iOS only","operationId":"CreateDraftVersion","security":[{"token":[]}],"tags":["Apple App Store"],"parameters":[],"responses":{"200":{"description":"Creates a version for review","content":{"application/json":{"examples":{"200 - Creates a version for review":{"value":null}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"app_id":{"type":"string","description":"The uuidV4 identifier of the app."},"version_string":{"type":"string","example":"1.2.3"}},"required":["app_id","version_string"]}}}}}},"/apple-app-store/app-versions/draft":{"get":{"summary":"Gets the App Store draft version","description":"The draft version is the latest unreleased version—the one that can be submitted for App Store review. If no such version exists, a draft version can be created. - IOS only","operationId":"GetDraftVersion","security":[{"token":[]}],"tags":["Apple App Store"],"parameters":[{"name":"app_id","in":"query","required":true,"description":"The uuidV4 identifier of the app.","schema":{"type":"string"}}],"responses":{"200":{"description":"Gets the draft version","content":{"application/json":{"examples":{"200 - Gets the draft version":{"value":{"app_store_state":"REVIEW_SUBMISSION_STATUS_WAITING_FOR_REVIEW","version_string":"1.0.0","release_type":"MANUAL","phased_release_state":"INACTIVE","start_date":null,"total_pause_duration":0,"current_day_number":0,"app_version_id":null}}}}}},"404":{"description":"Draft version is not found","content":{"application/json":{"examples":{"404 - Draft version is not found":{"value":{"code":"ERR_NOT_FOUND","message":"Draft version not found on App Store."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"patch":{"summary":"Updates the App Store draft version","description":"Updates the current App Store draft version—the latest unreleased version that can be submitted for App Store review. A local app version with the target version_string must already exist. - iOS only","operationId":"UpdateDraftVersion","security":[{"token":[]}],"tags":["Apple App Store"],"parameters":[],"responses":{"200":{"description":"Updates the draft version","content":{"application/json":{"examples":{"200 - Updates the draft version":{"value":{"id":"app-store-version-id","app_store_state":"PREPARE_FOR_SUBMISSION","version_string":"1.2.3","release_type":"MANUAL","earliest_release_date":null}}}}}},"404":{"description":"No App Store version exists","content":{"application/json":{"examples":{"404 - No local app version exists for the target version_string":{"value":{"code":"ERR_APP_VERSION_NOT_FOUND","message":"Could not find related app_version: version-without-a-release"}},"404 - No App Store version exists":{"value":{"code":"ERR_APP_STORE_VERSION_NOT_FOUND","message":"ReleaseManagement::ErrorHandling::NotFound"}}}}}},"409":{"description":"Draft version is not in an editable state","content":{"application/json":{"examples":{"409 - Draft version is not in an editable state":{"value":{"code":"ERR_CONFLICTS_WITH_CURRENT_STATE","message":"The App Store version's status is not in an editable state.","details":"Either complete the process in App Store Connect or cancel any outstanding reviews so that Release Management can continue the release flow here: https://appstoreconnect.apple.com/apps/1234/distribution/ios/version/inflight."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"app_id":{"type":"string","description":"The uuidV4 identifier of the app."},"version_string":{"type":"string","example":"1.2.3"}},"required":["app_id","version_string"]}}}}}},"/installable-artifacts":{"get":{"summary":"Gets the list of the installable artifacts.","description":"Gives back a list of installable artifacts.","operationId":"ListInstallableArtifacts","security":[{"token":[]}],"tags":["Installable Artifacts"],"parameters":[{"name":"app_id","in":"query","required":true,"description":"The uuidV4 identifier of the app the artifact is connected to.","schema":{"type":"string"}},{"name":"artifact_type","in":"query","required":false,"schema":{"enum":["aab","apk","ipa"],"type":"string"},"description":"Filter for a specific artifact type/extension."},{"name":"after_date","in":"query","required":false,"description":"A date in ISO 8601 string format specifying the start of the interval when the installable artifact created/uploaded. This value will be defaulted to 1 month ago if `distribution_ready` filter is not set or set to `false`.","schema":{"type":"string"}},{"name":"before_date","in":"query","required":false,"description":"A date in ISO 8601 string format specifying the end of the interval when the installable artifact created/uploaded. This value will be defaulted to the current time if `distribution_ready` filter is not set or set to `false`.","schema":{"type":"string"}},{"name":"branch","in":"query","required":false,"description":"Filter for the Bitrise CI branch the artifact has been generated on. (if applicable)","schema":{"type":"string"}},{"name":"distribution_ready","in":"query","required":false,"description":"Filter for distribution ready installable artifacts. This means `.apk` and `.ipa` (with distribution type `ad-hoc`, `development`, or `enterprise`) installable artifacts.","schema":{"type":"boolean"}},{"name":"items_per_page","in":"query","required":false,"schema":{"default":10,"maximum":50,"minimum":1,"type":"integer"},"description":"Specifies the maximum number of installable artifacts returned per request."},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer"},"description":"Specifies which page should be returned from the whole result set in a paginated scenario."},{"name":"platform","in":"query","required":false,"schema":{"enum":["ios","android"],"type":"string"},"description":"Filter for a specific mobile platform between your installable artifacts."},{"name":"search","in":"query","required":false,"description":"Search by version, filename, or build number (Bitrise CI). (case sensitive)","schema":{"type":"string"}},{"name":"source","in":"query","required":false,"schema":{"enum":["api","ci"],"type":"string"},"description":"Filter for the source of the installable artifacts."},{"name":"store_signed","in":"query","required":false,"description":"Filter for store ready installable artifacts. This means signed `.aab` and `.ipa` (with distribution type `app-store`) installable artifacts.","schema":{"type":"boolean"}},{"name":"version","in":"query","required":false,"description":"Filter for the version this artifact created for.This field is required if the `distribution_ready` filter is set to `true`.","schema":{"type":"string"}},{"name":"workflow","in":"query","required":false,"description":"Filter for the Bitrise CI workflow this artifact has been generated by. (if applicable)","schema":{"type":"string"}}],"responses":{"200":{"description":"Installable artifacts","content":{"application/json":{"examples":{"200 - Installable artifacts":{"value":{"count":3,"filters":{"after_date":1736673961,"before_date":1739265961},"has_next_page":false,"items":[{"app_name":"My Awesome App 0","branch":"master","build_number":"116","build_slug":"installable-artifact-build-slugi0","created_at":"2025-02-11T09:26:01.000Z","download_url":"some-download-url","filename_ext":".ipa","filename":"MyInstallableArtifact-1","id":"installable-artifact-slug-0","public_install_page_url":"https://app.bitrise.io/installable-artifacts/c71c1a5a-afe5-4129-a1a0-c3e1df2e3765/public-install-page/7eed2f6a199efe6b","platform":"ios","signature":"app-store","source":"ci","storage_provider":"gcs","store_app_id":"com.no.store.app.id","type":"ipa","uid":"c71c1a5a-afe5-4129-a1a0-c3e1df2e3765","formatted_version":"3.2.0 (1739265916)","version":"3.2.0","version_code":"1739265916","workflow":"build-ipa"},{"app_name":"My Awesome App 1","branch":"master","build_number":"117","build_slug":"installable-artifact-build-slugi1","created_at":"2025-02-11T09:26:01.000Z","download_url":"some-download-url","filename_ext":".ipa","filename":"MyInstallableArtifact-2","id":"installable-artifact-slug-1","public_install_page_url":"https://app.bitrise.io/installable-artifacts/75813a9f-33ce-4789-867c-3935f0aefe96/public-install-page/02bbfc0fed892eda","platform":"ios","signature":"app-store","source":"ci","storage_provider":"gcs","store_app_id":"com.no.store.app.id","type":"ipa","uid":"75813a9f-33ce-4789-867c-3935f0aefe96","formatted_version":"3.2.1 (1739265917)","version":"3.2.1","version_code":"1739265917","workflow":"build-ipa"},{"app_name":"My Awesome App 2","branch":"master","build_number":"118","build_slug":"installable-artifact-build-slugi2","created_at":"2025-02-11T09:26:01.000Z","download_url":"some-download-url","filename_ext":".ipa","filename":"MyInstallableArtifact-3","id":"installable-artifact-slug-2","public_install_page_url":"https://app.bitrise.io/installable-artifacts/92128991-72e5-4f31-b88c-a196b0ae963e/public-install-page/773971a2ecac09c3","platform":"ios","signature":"app-store","source":"ci","storage_provider":"gcs","store_app_id":"com.no.store.app.id","type":"ipa","uid":"92128991-72e5-4f31-b88c-a196b0ae963e","formatted_version":"3.2.2 (1739265918)","version":"3.2.2","version_code":"1739265918","workflow":"build-ipa"}]}}}}}},"400":{"description":"Bad Request - app_id is missing","content":{"application/json":{"examples":{"400 - Bad Request - app_id is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: app_id"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}}},"/installable-artifacts/{id}":{"delete":{"summary":"Deletes an installable artifact","description":"Deletes an API-uploaded installable artifact of an app.","operationId":"DeleteInstallableArtifact","security":[{"token":[]}],"tags":["Installable Artifacts"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Delete installable artifact","content":{"application/json":{"examples":{"204 - Delete installable artifact":{"value":{}}}}}},"422":{"description":"Installable artifact has been uploaded through CI","content":{"application/json":{"examples":{"422 - Installable artifact has been uploaded through CI":{"value":{"code":"ERR_UNPROCESSABLE_ENTITY","message":"Only artifacts uploaded using the Release Management Public API can be deletedthrough this endpoint."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"get":{"summary":"Gets an installable artifact.","description":"Returns the details of a single installable artifact.","operationId":"GetInstallableArtifact","security":[{"token":[]}],"tags":["Installable Artifacts"],"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the installable artifact.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Installable artifact","content":{"application/json":{"examples":{"200 - Installable artifact":{"value":{"app_name":"No Title Found","branch":"master","build_number":"112","build_slug":"build-slug","connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","created_at":"2025-02-11T09:26:01.000Z","distribution_ready":false,"download_path_or_url":"dummy-download-path","filename":"MyInstallableArtifact-115","filename_ext":".ipa","formatted_version":"1.0 (1)","id":"installable-artifact-slug-119","is_processed":true,"platform":"ios","project_id":"de351d6f-1324-4a9f-a23b-21faa2d03d5c","public_page_token":null,"signature":"unknown","source":"ci","store_app_id":"com.no.store.app.id","store_signed":null,"type":"ipa","uid":"5738cc8d-8b88-4791-b023-13f7023def3f","version":"1.0","version_code":"1","workflow":"primary","download_url":"some-download-url","file_size_bytes":0,"public_install_page_url":null,"min_os_version":null,"device_family_list":null,"export_method":null,"certificate_expires_at":null,"test_devices":null,"supported_device_types":[],"is_test_install_enabled":null}}}}}},"404":{"description":"Not found","content":{"application/json":{"examples":{"404 - Not found":{"value":{"code":"ERR_NOT_FOUND","message":"The installable artifact cannot be found."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}}},"/installable-artifacts/{id}/public-install-page":{"patch":{"summary":"Changes whether public install page should be available for the installable artifact or not.","description":"Changes whether public install page should be available for the installable artifact or not.","operationId":"SetPublicInstallPage","security":[{"token":[]}],"tags":["Installable Artifacts"],"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier for the installable artifact.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Enables public install page for installable artifact","content":{"application/json":{"examples":{"200 - Enables public install page for installable artifact":{"value":{}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - No permissions to enable public install page":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}},"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Installable artifact not found","content":{"application/json":{"examples":{"404 - Installable artifact not found":{"value":{"code":"ERR_NOT_FOUND","message":"The installable artifact cannot be found."}}}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"examples":{"422 - Unprocessable entity":{"value":{"code":"ERR_UNPROCESSABLE_ENTITY","message":"Can't enable public install page because no install methods are allowed."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"with_public_page":{"type":"boolean","description":"Boolean flag for enabling/disabling public install page for the installable artifact."}}}}}}}},"/installable-artifacts/{id}/status":{"get":{"summary":"Gets the status and reason of an installable artifact.","description":"Gets the processing and upload status of an installable artifact. Status can be one of:\n- 'upload_requested': This status is given back when an upload has been requested for the installable artifact, but didn't get uploaded yet.\n- 'uploaded': This status indicates that the installable artifact has been uploaded, but not yet processed.\n- 'processed_valid': This status means that the uploaded installable artifact has been successfully processed and that it is a valid artifact to be used for either build distribution or store release.\n- 'processed_invalid': This means that the uploaded installable artifact has been processed and that it is an invalid artifact, it cannot be used neither for build distribution nor for store release.\n- 'ready_to_upload': This status is only given to installable artifacts that are created using the deploy step on Bitrise CI. For API uploaded artifacts this will never be set.","operationId":"GetInstallableArtifactStatus","security":[{"token":[]}],"tags":["Installable Artifacts"],"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier for the installable artifact.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Gets installable artifact status with reason","content":{"application/json":{"examples":{"200 - Gets installable artifact status with reason":{"value":{"installable_artifact_id":"5738cc8d-8b88-4791-b023-13f7023def3f","status":"uploaded","status_reason":"Artifact uploaded, waiting for processing."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}}},"/installable-artifacts/{id}/upload-url":{"get":{"summary":"Generates an upload url for an installable artifact.","description":"Generates a signed upload url valid for 1 hour for an installable artifact to be uploaded to Bitrise.","operationId":"GenerateInstallableArtifactUploadUrl","security":[{"token":[]}],"tags":["Installable Artifacts"],"parameters":[{"name":"id","in":"path","description":"An uuidV4 identifier for the installable artifact.","required":true,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":true,"description":"The uuidV4 identifier of the app the artifact is connected to.","schema":{"type":"string"}},{"name":"file_name","in":"query","required":true,"description":"The name of the installable artifact file (with extension) to be uploaded to Bitrise.","schema":{"type":"string"}},{"name":"file_size_bytes","in":"query","required":true,"description":"The size of the file in bytes.","schema":{"type":"string"}},{"name":"with_public_page","in":"query","required":false,"description":"Optionally, you can enable public install page for your artifact. This can only be enabled by Admins, Owners and Workspace Admins. Changing this value without proper permissions will result in an error. The default value is false. ","schema":{"type":"boolean"}},{"name":"branch","in":"query","required":false,"description":"Optionally you can add the CI branch the artifact has been generated on.","schema":{"type":"string"}},{"name":"workflow","in":"query","required":false,"description":"Optionally you can add the CI workflow this artifact has been generated by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Get generated signed upload url","content":{"application/json":{"examples":{"200 - Get generated signed upload url":{"value":{"headers":{"Content-Type":"application/vnd.android.package-archive"},"method":"PUT","url":"https://bitrise-storage.com/platforms/android/apps/io.bitrise.test/artifacts/9a35afac-81a4-488d-a986-3c13015d70a0/artifact.apk?signed-url-data"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"examples":{"400 - when app_id parameter is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: app_id"}},"400 - when file name parameter is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: file_name"}},"400 - when file size bytes parameter is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: file_size_bytes"}},"400 - when artifact type does not match given connected app":{"value":{"code":"ERR_ARTIFACT_TYPE_MISMATCH","message":"The platform of the artifact does not match the platform of the given connected app."}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - No permissions to enable public install page":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to enable public install page. Only Admins, Owners and Workspace Admins can change this value."}},"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}}},"/installable-artifacts/{id}/what-to-test":{"get":{"summary":"Gets what to test information","description":"Gets what to test information for an installable artifact.","operationId":"GetWhatToTest","security":[{"token":[]}],"tags":["Installable Artifacts"],"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier for the installable artifact.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"What to test does not exist","content":{"application/json":{"examples":{"200 - What to test":{"value":{"what_to_test":"Test the new feature"}},"200 - What to test does not exist":{"value":{"what_to_test":null}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"patch":{"summary":"Update what to test information","description":"Update what to test information for an installable artifact.","operationId":"UpdateWhatToTest","security":[{"token":[]}],"tags":["Installable Artifacts"],"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier for the installable artifact.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"What to test exists and sending empty what to test","content":{"application/json":{"examples":{"204 - Update what to test":{"value":{}},"204 - What to test exists and sending empty what to test":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"what_to_test":{"type":"string","description":"The what to test information for the installable artifact. This should be a string with a maximum length of 4000 characters. To remove the what to test, send an empty string."}},"required":["what_to_test"]}}}}}},"/installable-artifacts/{installable_artifact_id}/custom-access-links":{"get":{"summary":"Lists custom access links for an installable artifact","description":"Returns a paginated list of custom access links for the given installable artifact.","operationId":"ListCustomAccessLinks","security":[{"token":[]}],"tags":["Installable Artifacts"],"parameters":[{"name":"installable_artifact_id","in":"path","required":true,"description":"The uuidV4 identifier of the installable artifact.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer"},"description":"Specifies which page should be returned from the whole result set."},{"name":"items_per_page","in":"query","required":false,"schema":{"default":10,"maximum":50,"minimum":1,"type":"integer"},"description":"Specifies the maximum number of items returned per request."},{"name":"sort_by","in":"query","required":false,"schema":{"enum":["name","created_at","expires_at"],"type":"string"},"description":"The field to sort results by. Defaults to name."},{"name":"sort_order","in":"query","required":false,"schema":{"enum":["asc","desc"],"type":"string"},"description":"The sort direction. Defaults to asc."}],"responses":{"200":{"description":"Custom access links","content":{"application/json":{"examples":{"200 - Custom access links":{"value":{"items":[{"id":"aaaaaaaa-0001-0000-0000-000000000000","name":"Alpha link","created_at":"2025-02-11T09:26:01.000Z","expires_at":null,"url":"http://unittest.bitrise.io/app-install/-6vgdwOcrQEagiCKvA6HKjnKOmSrl8ojUe1_DEODbP8","creator_email":"default-user@example.com","creator_name":"default-user","creator_avatar":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png","tester_group_name":"Beta Testers"},{"id":"aaaaaaaa-0002-0000-0000-000000000000","name":"Beta link","created_at":"2025-02-11T09:26:01.000Z","expires_at":null,"url":"http://unittest.bitrise.io/app-install/3bkkZjTdmuuMsUoJeX9brMihAAkK86c4vij_2uAf6xM","creator_email":"default-user@example.com","creator_name":"default-user","creator_avatar":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"}],"pagination":{"total_count":2,"current_page":1,"items_per_page":10}}}}}}},"404":{"description":"Installable artifact not found","content":{"application/json":{"examples":{"404 - Installable artifact not found":{"value":{"code":"ERR_NOT_FOUND","message":"The installable artifact cannot be found."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to list custom access links. Only Admins, Owners and Workspace Admins can list custom access links."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"post":{"summary":"Creates a custom access link for an installable artifact","description":"Creates a shareable custom access link for the given installable artifact.","operationId":"CreateCustomAccessLink","security":[{"token":[]}],"tags":["Installable Artifacts"],"parameters":[{"name":"installable_artifact_id","in":"path","required":true,"description":"The uuidV4 identifier of the installable artifact.","schema":{"type":"string"}}],"responses":{"201":{"description":"Creates link and notifies an external tester group","content":{"application/json":{"examples":{"201 - The created custom access link":{"value":{"id":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee","name":"QA release link","created_at":"2025-02-11T09:26:01.000Z","expires_at":null,"url":"https://app.bitrise.io/app-install/example-token","creator_email":"default-user@example.com","creator_name":"default-user","creator_avatar":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"}},"201 - Creates link and notifies an external tester group":{"value":{"id":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee","name":"Beta testers link","created_at":"2025-02-11T09:26:01.000Z","expires_at":null,"url":"https://app.bitrise.io/app-install/example-token","creator_email":"default-user@example.com","creator_name":"default-user","creator_avatar":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"}}}}}},"400":{"description":"Artifact is not distribution-ready","content":{"application/json":{"examples":{"400 - Expiry date is invalid":{"value":{"code":"ERR_VALIDATION","message":"ArgumentError","details":{"expires_at":"Expiry date must be a valid ISO8601 date-time."}}},"400 - Access code is invalid":{"value":{"code":"ERR_VALIDATION","message":"ReleaseManagement::ErrorHandling::ValidationError","details":{"access_code":"Access code must be between 8 and 64 characters."}}},"400 - Tester group is not external":{"value":{"code":"ERR_VALIDATION","message":"Only external tester groups can be notified via an access link"}},"400 - Artifact is not distribution-ready":{"value":{"code":"ERR_VALIDATION","message":"The provided artifact cannot be used for tester group notifications, id: `5738cc8d-8b88-4791-b023-13f7023def3f`"}}}}}},"404":{"description":"Installable artifact not found","content":{"application/json":{"examples":{"404 - Installable artifact not found":{"value":{"code":"ERR_NOT_FOUND","message":"The installable artifact cannot be found."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to create a custom access link. Only Admins, Owners and Workspace Admins can create custom access links."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"A human-readable label for the access link. Defaults to the tester group name when tester_group_id is provided."},"expires_at":{"type":"string","description":"ISO 8601 datetime string after which the link will no longer be accessible. Omit for a non-expiring link."},"access_code":{"type":"string","description":"Optional access code (8–64 characters) required to unlock the install page."},"tester_group_id":{"type":"string","description":"Optional ID of an external tester group to notify with this link after creation."}}}}}}}},"/installable-artifacts/{installable_artifact_id}/custom-access-links/{id}":{"delete":{"summary":"Deletes a custom access link","description":"Permanently deletes a custom access link. The install page URL will no longer be accessible after deletion.","operationId":"DeleteCustomAccessLink","security":[{"token":[]}],"tags":["Installable Artifacts"],"parameters":[{"name":"installable_artifact_id","in":"path","required":true,"description":"The uuidV4 identifier of the installable artifact.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The uuidV4 identifier of the custom access link.","schema":{"type":"string"}}],"responses":{"204":{"description":"Custom access link deleted","content":{"application/json":{"examples":{"204 - Custom access link deleted":{"value":{}}}}}},"404":{"description":"Installable artifact not found","content":{"application/json":{"examples":{"404 - Custom access link not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}},"404 - Installable artifact not found":{"value":{"code":"ERR_NOT_FOUND","message":"The installable artifact cannot be found."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to delete a custom access link. Only Admins, Owners and Workspace Admins can delete custom access links."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"patch":{"summary":"Updates a custom access link","description":"Updates the name, expiry, or access code of an existing custom access link.","operationId":"UpdateCustomAccessLink","security":[{"token":[]}],"tags":["Installable Artifacts"],"parameters":[{"name":"installable_artifact_id","in":"path","required":true,"description":"The uuidV4 identifier of the installable artifact.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The uuidV4 identifier of the custom access link.","schema":{"type":"string"}}],"responses":{"200":{"description":"The updated custom access link","content":{"application/json":{"examples":{"200 - The updated custom access link":{"value":{"id":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee","name":"Updated link name","created_at":"2025-02-11T09:26:01.000Z","expires_at":null,"url":"https://app.bitrise.io/app-install/example-token","creator_email":"default-user@example.com","creator_name":"default-user","creator_avatar":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"}}}}}},"400":{"description":"Expiry date is invalid","content":{"application/json":{"examples":{"400 - Access code is invalid":{"value":{"code":"ERR_VALIDATION","message":"ReleaseManagement::ErrorHandling::ValidationError","details":{"access_code":"Access code must be between 8 and 64 characters."}}},"400 - Expiry date is invalid":{"value":{"code":"ERR_VALIDATION","message":"ArgumentError","details":{"expires_at":"Expiry date must be a valid ISO8601 date-time."}}}}}}},"404":{"description":"Installable artifact not found","content":{"application/json":{"examples":{"404 - Custom access link not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}},"404 - Installable artifact not found":{"value":{"code":"ERR_NOT_FOUND","message":"The installable artifact cannot be found."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to update a custom access link. Only Admins, Owners and Workspace Admins can update custom access links."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"A human-readable label for the access link. Existing value is preserved when omitted."},"expires_at":{"type":"string","description":"ISO 8601 datetime string after which the link will no longer be accessible. Pass null to remove expiry."},"access_code":{"type":"string","description":"Optional access code (8–64 characters) required to unlock the install page. Pass null to remove the access code."}}}}}}}},"/outgoing-webhooks/{id}":{"delete":{"summary":"Deletes an outgoing webhook","description":"Deletes an outgoing webhook.","security":[{"token":[]}],"tags":["Outgoing Webhooks"],"operationId":"DeleteOutgoingWebhook","parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the outgoing webhook to update.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Delete outgoing webhook","content":{"application/json":{"examples":{"204 - Delete outgoing webhook":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"get":{"summary":"Gets an outgoing webhook","description":"Gets an outgoing webhook.","operationId":"GetOutgoingWebhook","security":[{"token":[]}],"tags":["Outgoing Webhooks"],"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the outgoing webhook.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Gets outgoing webhook","content":{"application/json":{"examples":{"200 - Gets outgoing webhook":{"value":{"id":"75be346f-2e70-44c9-95af-7dc7c8f0c48e","created_at":"2024-05-09T15:52:21.000Z","events":["release_candidate_set"],"all_events":false,"webhook_configuration_id":"5623239f-28ea-4b8d-856e-8cb50073fade"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"patch":{"summary":"Updates an outgoing webhook","description":"Updates an outgoing webhook associated with the given app version.","security":[{"token":[]}],"tags":["Outgoing Webhooks"],"operationId":"UpdateOutgoingWebhook","parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the outgoing webhook to update.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Update outgoing webhook","content":{"application/json":{"examples":{"200 - Update outgoing webhook":{"value":{"id":"75be346f-2e70-44c9-95af-7dc7c8f0c48e","created_at":"2024-05-09T15:52:21.000Z","events":["release_candidate_set"],"all_events":true,"webhook_configuration_id":"5623239f-28ea-4b8d-856e-8cb50073fade"}}}}}},"400":{"description":"Webhook configuration is not associated with the workspace of the app version","content":{"application/json":{"examples":{"400 - Webhook configuration is not associated with the workspace of the app version":{"value":{"code":"ERR_INVALID_WEBHOOK_CONFIGURATION","message":"The given webhook configuration is not registered on the workspace."}}}}}},"404":{"description":"Webhook configuration does not exist","content":{"application/json":{"examples":{"404 - Webhook configuration does not exist":{"value":{"code":"ERR_NOT_FOUND","message":"Webhook configuration does not exist."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed","app_store_release_cancelled","app_store_release_completed","app_store_release_started","app_store_review_approved","app_store_review_cancelled","app_store_review_rejected","app_store_review_submitted","app_store_version_created","app_store_version_updated","app_version_added","approval_task_added","approval_task_changed","approval_task_completed","approval_task_deleted","approval_task_reopened","approval_tasks_completed","auto-upload_disabled","auto-upload_enabled","automation_added","automation_removed","google_play_automated_rollout_cancelled","google_play_automated_rollout_configured","google_play_automated_rollout_paused","google_play_automated_rollout_resumed","google_play_release_completed","google_play_release_notes_localization_added","google_play_release_notes_localization_changed","google_play_release_notes_localization_removed","google_play_release_started","google_play_rollout_percentage_changed","google_play_testing_track_release_completed","google_play_testing_track_release_failed","google_play_upload_completed","google_play_upload_failed","google_play_upload_started","metadata_localization_added","metadata_localization_changed","metadata_localization_removed","microsoft_teams_connection_changed","outgoing_webhook_added","outgoing_webhook_deleted","outgoing_webhook_updated","phased_release_disabled","phased_release_enabled","phased_release_paused","phased_release_resumed","release_candidate_auto_select_latest_build_disabled","release_candidate_auto_select_latest_build_enabled","release_candidate_build_selected","release_candidate_source_changed","release_description_changed","release_settings_changed","slack_connection_changed","stopped_managing_release","testflight_app_review_approved","testflight_app_review_rejected","testflight_app_review_submitted","testflight_distribution_start_failed","testflight_distribution_started","testflight_distribution_stopped","testflight_processing_completed","testflight_processing_failed","testflight_upload_completed","testflight_upload_failed","testflight_upload_started","testflight_what_to_test_added","testflight_what_to_test_changed","testflight_what_to_test_deleted"]},"description":"A list of event names that will trigger this webhook. These events correspond to specific actions or states in the release process."},"all_events":{"type":"boolean","description":"Indicates whether this webhook should be triggered for all events. Set to true to enable the webhook for every event."},"webhook_configuration_id":{"type":"string","description":"The unique identifier of the webhook configuration that can be found in the workspace integration settings."}}}}}}}},"/outgoing-webhooks/{id}/deliveries":{"get":{"summary":"Gets a list of outgoing webhook deliveries.","description":"Gives back the list of outgoing webhook deliveries associated with the given webhook configuration.","operationId":"ListOutgoingWebhookDeliveries","security":[{"token":[]}],"tags":["Outgoing Webhooks"],"parameters":[{"name":"id","in":"path","description":"Release Management webhook UUIDv4.","required":true,"schema":{"type":"string"}},{"name":"after_date","in":"query","required":false,"description":"A date in ISO 8601 string format specifying the start of the interval when the delivery occurred. This value will be defaulted to 30 days ago if not given.","schema":{"type":"string"}},{"name":"before_date","in":"query","required":false,"description":"A date in ISO 8601 string format specifying the end of the interval when the delivery occurred. This value will be defaulted to the current time if not given.","schema":{"type":"string"}},{"name":"items_per_page","in":"query","required":false,"schema":{"default":10,"maximum":50,"minimum":1,"type":"integer"},"description":"Specifies the maximum number of installable artifacts returned per request."},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer"},"description":"Specifies which page should be returned from the whole result set in a paginated scenario."},{"name":"status","in":"query","required":false,"schema":{"enum":["failed","successful"],"type":"string"},"description":"Filter for a specific status."},{"name":"source_event_type","in":"query","required":false,"schema":{"enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed","app_store_release_cancelled","app_store_release_completed","app_store_release_started","app_store_review_approved","app_store_review_cancelled","app_store_review_rejected","app_store_review_submitted","app_store_version_created","app_store_version_updated","app_version_added","approval_task_added","approval_task_changed","approval_task_completed","approval_task_deleted","approval_task_reopened","approval_tasks_completed","auto-upload_disabled","auto-upload_enabled","automation_added","automation_removed","google_play_automated_rollout_cancelled","google_play_automated_rollout_configured","google_play_automated_rollout_paused","google_play_automated_rollout_resumed","google_play_release_completed","google_play_release_notes_localization_added","google_play_release_notes_localization_changed","google_play_release_notes_localization_removed","google_play_release_started","google_play_rollout_percentage_changed","google_play_testing_track_release_completed","google_play_testing_track_release_failed","google_play_upload_completed","google_play_upload_failed","google_play_upload_started","metadata_localization_added","metadata_localization_changed","metadata_localization_removed","microsoft_teams_connection_changed","outgoing_webhook_added","outgoing_webhook_deleted","outgoing_webhook_updated","phased_release_disabled","phased_release_enabled","phased_release_paused","phased_release_resumed","release_candidate_auto_select_latest_build_disabled","release_candidate_auto_select_latest_build_enabled","release_candidate_build_selected","release_candidate_source_changed","release_description_changed","release_settings_changed","slack_connection_changed","stopped_managing_release","testflight_app_review_approved","testflight_app_review_rejected","testflight_app_review_submitted","testflight_distribution_start_failed","testflight_distribution_started","testflight_distribution_stopped","testflight_processing_completed","testflight_processing_failed","testflight_upload_completed","testflight_upload_failed","testflight_upload_started","testflight_what_to_test_added","testflight_what_to_test_changed","testflight_what_to_test_deleted"],"type":"string"},"description":"Filter for a specific event type."}],"responses":{"200":{"description":"Outgoing webhook deliveries","content":{"application/json":{"examples":{"200 - Outgoing webhook deliveries":{"value":{"items":[{"created_at":"2025-02-11T09:26:01.000Z","id":"dc1e1231-a407-4391-91b0-e0f4b3ee022b","request_headers":[{"name":"Authorization","value":"Bearer token","hide":false},{"name":"X-Custom-Header","value":"custom","hide":false}],"request_payload":{"release_id":"8ef26387-98aa-43fe-b113-fe32b606b87e"},"request_url":"https://example.com/webhook","response_body":null,"response_headers":null,"response_http_status":null,"response_duration_seconds":0,"source_event_type":"release_candidate_set","source_product":"release_management","webhook_config_id":"5623239f-28ea-4b8d-856e-8cb50073fade"},{"created_at":"2025-02-11T09:26:01.000Z","id":"ed404b37-35ce-4e9e-859c-5d24c6bd603e","request_headers":[{"name":"Authorization","value":"Bearer token","hide":false},{"name":"X-Custom-Header","value":"custom","hide":false}],"request_payload":{"release_id":"8ef26387-98aa-43fe-b113-fe32b606b87e"},"request_url":"https://example.com/webhook","response_body":null,"response_headers":null,"response_http_status":null,"response_duration_seconds":0,"source_event_type":"release_candidate_set","source_product":"release_management","webhook_config_id":"5623239f-28ea-4b8d-856e-8cb50073fade"},{"created_at":"2025-02-11T09:26:01.000Z","id":"c35cb7c7-63ce-4f25-88b8-5dece26b6c6e","request_headers":[{"name":"Authorization","value":"Bearer token","hide":false},{"name":"X-Custom-Header","value":"custom","hide":false}],"request_payload":{"release_id":"8ef26387-98aa-43fe-b113-fe32b606b87e"},"request_url":"https://example.com/webhook","response_body":null,"response_headers":null,"response_http_status":null,"response_duration_seconds":0,"source_event_type":"release_candidate_set","source_product":"release_management","webhook_config_id":"5623239f-28ea-4b8d-856e-8cb50073fade"},{"created_at":"2025-02-11T09:26:01.000Z","id":"41f2bdc3-1af5-4f5f-85a4-d4efe79f9015","request_headers":[{"name":"Authorization","value":"Bearer token","hide":false},{"name":"X-Custom-Header","value":"custom","hide":false}],"request_payload":{"release_id":"8ef26387-98aa-43fe-b113-fe32b606b87e"},"request_url":"https://example.com/webhook","response_body":null,"response_headers":null,"response_http_status":null,"response_duration_seconds":0,"source_event_type":"release_candidate_set","source_product":"release_management","webhook_config_id":"5623239f-28ea-4b8d-856e-8cb50073fade"}],"total_count":4}}}}}},"400":{"description":"Bad request","content":{"application/json":{"examples":{"400 - Bad request":{"value":{"code":"ERR_BAD_REQUEST","message":"Invalid delivery status given as a filter: invalid status. Valid statuses are: failed, successful."}}}}}},"404":{"description":"Not found","content":{"application/json":{"examples":{"404 - Not found":{"value":{"code":"ERR_NOT_FOUND","message":"Related webhook configuration not found."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}}},"/outgoing-webhooks/{id}/deliveries/{delivery_id}/redeliver":{"post":{"summary":"Redelivers an outgoing webhook.","description":"Redelivers an outgoing webhook.","operationId":"RedeliverOutgoingWebhook","security":[{"token":[]}],"tags":["Outgoing Webhooks"],"parameters":[{"name":"id","in":"path","description":"Release Management webhook UUIDv4.","required":true,"schema":{"type":"string"}},{"name":"delivery_id","in":"path","description":"The UUIDv4 id of the outgoing webhook delivery to redeliver.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Redelivers outgoing webhook","content":{"application/json":{"examples":{"204 - Redelivers outgoing webhook":{"value":{}}}}}},"404":{"description":"Not found","content":{"application/json":{"examples":{"404 - Not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}}},"/presets":{"get":{"summary":"Gets a list of preset templates","description":"Gets a list of preset templates for the app.","operationId":"GetPresetsList","security":[{"token":[]}],"tags":["Presets"],"parameters":[{"name":"app_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Presets","content":{"application/json":{"examples":{"200 - Presets":{"value":{"items":[{"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","id":"157f4a5a-edb4-49a3-ab0b-ef0a865ef821","template_name":"","default":false,"description":"","auto_upload":true,"approvals":[{"summary":"qa-check","description":"After quality assurance has finished testing, check back here."},{"summary":"security-check","description":"Everything is adhering to our security policies."}],"notifications":{"slack_webhook_url":"https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX","teams_webhook_url":"https://outlook.office.com/webhookb2/valid","slack_notification_integration_id":"ceec9565-0de0-4603-92b2-255e42c2d203"},"automation":[{"event_name":"release_candidate_set","workflow_name":"google-ser-cred-test"},{"event_name":"approvals_completed","pipeline_name":"notify-stakeholders"}],"release_notes":[{"locale":"en-GB","whats_new":"What is new in english"},{"locale":"hu","whats_new":"What is new in hungarian"}],"default_release_method":"phased","app_store_release_type":"MANUAL","outgoing_webhooks":null,"release_candidate":{"branch":"main","workflow":"build-new-app-version","source":"ci","auto_select":true}},{"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","id":"ed81ff4b-e4d8-4f29-a442-386706a41a93","template_name":"","default":false,"description":"","auto_upload":true,"approvals":[{"summary":"qa-check","description":"After quality assurance has finished testing, check back here."},{"summary":"security-check","description":"Everything is adhering to our security policies."}],"notifications":{"slack_webhook_url":"https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX","teams_webhook_url":"https://outlook.office.com/webhookb2/valid","slack_notification_integration_id":"ceec9565-0de0-4603-92b2-255e42c2d203"},"automation":[{"event_name":"release_candidate_set","workflow_name":"google-ser-cred-test"},{"event_name":"approvals_completed","pipeline_name":"notify-stakeholders"}],"release_notes":[{"locale":"en-GB","whats_new":"What is new in english"},{"locale":"hu","whats_new":"What is new in hungarian"}],"default_release_method":"phased","app_store_release_type":"MANUAL","outgoing_webhooks":null,"release_candidate":{"branch":"main","workflow":"build-new-app-version","source":"ci","auto_select":true}}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"post":{"summary":"Creates a preset template","description":"Creates a preset template for the app.","operationId":"CreatePreset","security":[{"token":[]}],"tags":["Presets"],"parameters":[],"responses":{"200":{"description":"Presets","content":{"application/json":{"examples":{"200 - Presets":{"value":{"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","id":"921db057-73eb-418a-b7ed-04f451e9dd85","template_name":"Modified Preset Template","default":false,"description":"","auto_upload":false,"approvals":[{"summary":"qa-check","description":"Modified - After quality assurance has finished testing, check back here."},{"summary":"security-check","description":"Modified - Everything is adhering to our security policies."}],"notifications":{"teams_webhook_url":"https://outlook.office.com/webhookb2/modified","slack_notification_integration_id":"ceec9565-0de0-4603-92b2-255e42c2d203"},"automation":[{"event_name":"release_candidate_set","workflow_name":"modified-google-ser-cred-test"},{"event_name":"approvals_completed","pipeline_name":"modified-notify-stakeholders"}],"release_notes":null,"default_release_method":null,"app_store_release_type":"MANUAL","outgoing_webhooks":[{"all_events":true,"webhook_configuration_id":"88db186d-4776-4e32-aab3-1a7f93919171"},{"all_events":false,"events":["approvals_completed","release_candidate_set"],"webhook_configuration_id":"1591e3b6-fefe-47bc-a64d-c6fda12a3db5"}],"release_candidate":{"branch":"modified-main","workflow":"modified-build-app","source":"ci","auto_select":true}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"examples":{"400 - Bad request":{"value":{"code":"ERR_VALIDATION","message":"ProductPlatform::Service::Error::NotFound"}}}}}},"409":{"description":"Conflict","content":{"application/json":{"examples":{"409 - Conflict":{"value":{"code":"ERR_DUPLICATED_AUTOMATION_PIPELINE_PAIR","message":"automation already exists: [{\"event_name\":\"release_candidate_set\",\"workflow_name\":\"workflow_1\"},{\"event_name\":\"release_candidate_set\",\"workflow_name\":\"workflow_1\"}]"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"app_id":{"type":"string","description":"The uuidV4 identifier of the app."},"default":{"type":"boolean","description":"If set to true, this preset will be used as the default template for the app."},"release_candidate":{"type":"object","properties":{"source":{"type":"string","enum":["ci","api"]},"branch":{"type":"string"},"workflow":{"type":"string"},"auto_select":{"type":"boolean"}}},"auto_upload":{"type":"boolean","description":"If set to true, Release Management will upload all successful builds that ran on the given branch with the given workflow to the App Store."},"notifications":{"type":"object","properties":{"slack_webhook_url":{"type":"string","deprecated":true,"description":"You can get notifications about release updates on Slack by setting this value. Make sure to send the properly formatted webhook url. Regex for validation: ^https:\\/\\/.*\\.slack\\.com\\/services\\/T[a-zA-Z0-9]*\\/B[a-zA-Z0-9]*\\/[a-zA-Z0-9]*$"},"slack_notification_integration_id":{"type":"string","description":"You can get notifications about release updates on Slack by setting this value. Make sure to send the an integration ID found in Workspace Settings."},"teams_webhook_url":{"type":"string","description":"You can get notifications about release updates on Teams by setting this value. Make sure to send the properly formatted webhook url. Regex for validation: ^https:\\/\\/(?:.*\\.webhook|outlook)\\.office(?:365)?\\.com\\/webhookb2\\/.*"}}},"approvals":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"summary":{"type":"string"}}},"description":"Tasks for the approval stage. Sending this value will replace the possibly already existing approval task list."},"automation":{"type":"array","items":{"type":"object","properties":{"event_name":{"enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed"],"type":"string"},"workflow_name":{"type":"string"},"pipeline_name":{"type":"string"}}},"description":"Automation events (workflow or pipeline runs) setup for specific event types. Sending this value will replace the possibly already existing automation list."},"outgoing_webhooks":{"type":"array","items":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed","app_store_release_cancelled","app_store_release_completed","app_store_release_started","app_store_review_approved","app_store_review_cancelled","app_store_review_rejected","app_store_review_submitted","app_store_version_created","app_store_version_updated","app_version_added","approval_task_added","approval_task_changed","approval_task_completed","approval_task_deleted","approval_task_reopened","approval_tasks_completed","auto-upload_disabled","auto-upload_enabled","automation_added","automation_removed","google_play_automated_rollout_cancelled","google_play_automated_rollout_configured","google_play_automated_rollout_paused","google_play_automated_rollout_resumed","google_play_release_completed","google_play_release_notes_localization_added","google_play_release_notes_localization_changed","google_play_release_notes_localization_removed","google_play_release_started","google_play_rollout_percentage_changed","google_play_testing_track_release_completed","google_play_testing_track_release_failed","google_play_upload_completed","google_play_upload_failed","google_play_upload_started","metadata_localization_added","metadata_localization_changed","metadata_localization_removed","microsoft_teams_connection_changed","outgoing_webhook_added","outgoing_webhook_deleted","outgoing_webhook_updated","phased_release_disabled","phased_release_enabled","phased_release_paused","phased_release_resumed","release_candidate_auto_select_latest_build_disabled","release_candidate_auto_select_latest_build_enabled","release_candidate_build_selected","release_candidate_source_changed","release_description_changed","release_settings_changed","slack_connection_changed","stopped_managing_release","testflight_app_review_approved","testflight_app_review_rejected","testflight_app_review_submitted","testflight_distribution_start_failed","testflight_distribution_started","testflight_distribution_stopped","testflight_processing_completed","testflight_processing_failed","testflight_upload_completed","testflight_upload_failed","testflight_upload_started","testflight_what_to_test_added","testflight_what_to_test_changed","testflight_what_to_test_deleted"]},"description":"A list of event names that will trigger this webhook. These events correspond to specific actions or states in the release process."},"all_events":{"type":"boolean","description":"Indicates whether this webhook should be triggered for all events. Set to true to enable the webhook for every event."},"webhook_configuration_id":{"type":"string","description":"The unique identifier of the webhook, that can be found in the workspace integration settings. This ID links the webhook to the workspace."}}},"description":"COMING SOON. A collection of outgoing webhooks configured to trigger for specific event types. Each webhook can be associated with one or more events or set to trigger for all events."},"template_name":{"type":"string","description":"The name of the preset template."}},"required":["app_id","template_name"]}}}}}},"/presets/{id}":{"delete":{"summary":"Deletes a preset template","description":"Deletes a preset template.","operationId":"DeletePreset","security":[{"token":[]}],"tags":["Presets"],"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the preset template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The deleted preset","content":{"application/json":{"examples":{"200 - The deleted preset":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"get":{"summary":"Gets a preset template","description":"Gets a preset template for the app.","operationId":"GetPresets","security":[{"token":[]}],"tags":["Presets"],"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the preset template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Presets","content":{"application/json":{"examples":{"200 - Presets":{"value":{"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","id":"ed81ff4b-e4d8-4f29-a442-386706a41a93","template_name":"","default":false,"description":"","auto_upload":true,"approvals":[{"summary":"qa-check","description":"After quality assurance has finished testing, check back here."},{"summary":"security-check","description":"Everything is adhering to our security policies."}],"notifications":{"slack_webhook_url":"https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX","teams_webhook_url":"https://outlook.office.com/webhookb2/valid","slack_notification_integration_id":"ceec9565-0de0-4603-92b2-255e42c2d203"},"automation":[{"event_name":"release_candidate_set","workflow_name":"google-ser-cred-test"},{"event_name":"approvals_completed","pipeline_name":"notify-stakeholders"}],"release_notes":[{"locale":"en-GB","whats_new":"What is new in english"},{"locale":"hu","whats_new":"What is new in hungarian"}],"default_release_method":"phased","app_store_release_type":"MANUAL","outgoing_webhooks":[{"all_events":true,"webhook_configuration_id":"b203f887-05e7-4ac2-a4b7-13ce0a02316e"},{"events":["release_created","release_candidate_set"],"all_events":false,"webhook_configuration_id":"7613aaac-5822-4b83-8050-7c4a273b6d56"}],"release_candidate":{"branch":"main","workflow":"build-new-app-version","source":"ci","auto_select":true}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"put":{"summary":"Updates the preset template","description":"Updates the preset template for the app.","operationId":"UpdatePresets","security":[{"token":[]}],"tags":["Presets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Presets","content":{"application/json":{"examples":{"200 - Presets":{"value":{"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","id":"ed81ff4b-e4d8-4f29-a442-386706a41a93","template_name":"","default":false,"description":"","auto_upload":false,"approvals":[{"summary":"qa-check","description":"Modified - After quality assurance has finished testing, check back here."},{"summary":"security-check","description":"Modified - Everything is adhering to our security policies."}],"notifications":{"teams_webhook_url":"https://outlook.office.com/webhookb2/modified","slack_notification_integration_id":"ceec9565-0de0-4603-92b2-255e42c2d203"},"automation":[{"event_name":"release_candidate_set","workflow_name":"modified-google-ser-cred-test"},{"event_name":"approvals_completed","pipeline_name":"modified-notify-stakeholders"}],"release_notes":[{"locale":"en-GB","whats_new":"What is new in english"},{"locale":"hu","whats_new":"What is new in hungarian"}],"default_release_method":"phased","app_store_release_type":"MANUAL","outgoing_webhooks":[{"all_events":true,"webhook_configuration_id":"738f9f7c-5ee6-4546-84d7-d91951a742c5"},{"events":["approvals_completed","release_candidate_set"],"all_events":false,"webhook_configuration_id":"ccdfc531-df50-4ed9-a610-ad7599cf27a2"}],"release_candidate":{"branch":"modified-main","workflow":"modified-build-app","source":"ci","auto_select":true}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"examples":{"400 - Bad request":{"value":{"code":"ERR_VALIDATION","message":"ProductPlatform::Service::Error::NotFound"}}}}}},"409":{"description":"Conflict","content":{"application/json":{"examples":{"409 - Conflict":{"value":{"code":"ERR_DUPLICATED_AUTOMATION_PIPELINE_PAIR","message":"automation already exists: [{\"event_name\":\"release_candidate_set\",\"workflow_name\":\"workflow_1\"},{\"event_name\":\"release_candidate_set\",\"workflow_name\":\"workflow_1\"}]"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"default":{"type":"boolean","description":"If set to true, this preset will be used as the default template for the app."},"release_candidate":{"type":"object","properties":{"source":{"type":"string","enum":["ci","api"]},"branch":{"type":"string"},"workflow":{"type":"string"},"auto_select":{"type":"boolean"}}},"auto_upload":{"type":"boolean","description":"If set to true, Release Management will upload all successful builds that ran on the given branch with the given workflow to the App Store."},"notifications":{"type":"object","properties":{"slack_webhook_url":{"type":"string","deprecated":true,"description":"You can get notifications about release updates on Slack by setting this value. Make sure to send the properly formatted webhook url. Regex for validation: ^https:\\/\\/.*\\.slack\\.com\\/services\\/T[a-zA-Z0-9]*\\/B[a-zA-Z0-9]*\\/[a-zA-Z0-9]*$"},"slack_notification_integration_id":{"type":"string","description":"You can get notifications about release updates on Slack by setting this value. Make sure to send the an integration ID found in Workspace Settings."},"teams_webhook_url":{"type":"string","description":"You can get notifications about release updates on Teams by setting this value. Make sure to send the properly formatted webhook url. Regex for validation: ^https:\\/\\/(?:.*\\.webhook|outlook)\\.office(?:365)?\\.com\\/webhookb2\\/.*"}}},"approvals":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"summary":{"type":"string"}}},"description":"Tasks for the approval stage. Sending this value will replace the possibly already existing approval task list."},"automation":{"type":"array","items":{"type":"object","properties":{"event_name":{"enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed"],"type":"string"},"workflow_name":{"type":"string"},"pipeline_name":{"type":"string"}}},"description":"Automation events (workflow or pipeline runs) setup for specific event types. Sending this value will replace the possibly already existing automation list."},"outgoing_webhooks":{"type":"array","items":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed","app_store_release_cancelled","app_store_release_completed","app_store_release_started","app_store_review_approved","app_store_review_cancelled","app_store_review_rejected","app_store_review_submitted","app_store_version_created","app_store_version_updated","app_version_added","approval_task_added","approval_task_changed","approval_task_completed","approval_task_deleted","approval_task_reopened","approval_tasks_completed","auto-upload_disabled","auto-upload_enabled","automation_added","automation_removed","google_play_automated_rollout_cancelled","google_play_automated_rollout_configured","google_play_automated_rollout_paused","google_play_automated_rollout_resumed","google_play_release_completed","google_play_release_notes_localization_added","google_play_release_notes_localization_changed","google_play_release_notes_localization_removed","google_play_release_started","google_play_rollout_percentage_changed","google_play_testing_track_release_completed","google_play_testing_track_release_failed","google_play_upload_completed","google_play_upload_failed","google_play_upload_started","metadata_localization_added","metadata_localization_changed","metadata_localization_removed","microsoft_teams_connection_changed","outgoing_webhook_added","outgoing_webhook_deleted","outgoing_webhook_updated","phased_release_disabled","phased_release_enabled","phased_release_paused","phased_release_resumed","release_candidate_auto_select_latest_build_disabled","release_candidate_auto_select_latest_build_enabled","release_candidate_build_selected","release_candidate_source_changed","release_description_changed","release_settings_changed","slack_connection_changed","stopped_managing_release","testflight_app_review_approved","testflight_app_review_rejected","testflight_app_review_submitted","testflight_distribution_start_failed","testflight_distribution_started","testflight_distribution_stopped","testflight_processing_completed","testflight_processing_failed","testflight_upload_completed","testflight_upload_failed","testflight_upload_started","testflight_what_to_test_added","testflight_what_to_test_changed","testflight_what_to_test_deleted"]},"description":"A list of event names that will trigger this webhook. These events correspond to specific actions or states in the release process."},"all_events":{"type":"boolean","description":"Indicates whether this webhook should be triggered for all events. Set to true to enable the webhook for every event."},"webhook_configuration_id":{"type":"string","description":"The unique identifier of the webhook, that can be found in the workspace integration settings. This ID links the webhook to the workspace."}}},"description":"COMING SOON. A collection of outgoing webhooks configured to trigger for specific event types. Each webhook can be associated with one or more events or set to trigger for all events."}}}}}}}},"/public-assets/{id}/status":{"get":{"summary":"Gets the status and reason of a public asset.","description":"Gets the processing and upload status of a public asset. Status can be one of:\n- 'upload_requested': This status is given back when an upload has been requested for the public asset, but didn't get uploaded yet.\n- 'uploaded': This status indicates that the public asset has been uploaded, but not yet processed.\n- 'processed_valid': This status means that the uploaded public asset has been successfully processed and that it is a valid artifact to be used for either build distribution or store release.\n- 'processed_invalid': This means that the uploaded public asset has been processed and that it is an invalid artifact, it cannot be used neither for build distribution nor for store release.\n- 'ready_to_upload': This status is only given to public assets that are created using the deploy step on Bitrise CI. For API uploaded artifacts this will never be set.","operationId":"GetPublicAssetStatus","security":[{"token":[]}],"tags":["Public Assets"],"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier for the public asset.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Gets public asset status with reason","content":{"application/json":{"examples":{"200 - Gets public asset status with reason":{"value":{"public_asset_id":"dd6fadd2-6e4b-4bda-b6e2-aa319cdc89cd","status":"processed_valid","status_reason":"The asset has been processed and ready to be used."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}}},"/public-assets/{id}/upload-url":{"get":{"summary":"Generates a signed upload url valid for 1 hour for a public asset to be uploaded to Bitrise.","description":"NOTE:\n- In case of app icons, after a successful upload the icon of the app will be replaced!\n","operationId":"GeneratePublicAssetUploadUrl","security":[{"token":[]}],"tags":["Public Assets"],"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier for the public asset.","required":true,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":true,"description":"The uuidV4 identifier of the app the asset is connected to.","schema":{"type":"string"}},{"name":"asset_type","in":"query","required":true,"schema":{"enum":["app_icon"],"type":"string"},"description":"The type of the public asset."},{"name":"file_name","in":"query","required":true,"description":"The name of the public asset file (with extension) to be uploaded to Bitrise.","schema":{"type":"string"}},{"name":"file_size_bytes","in":"query","required":true,"description":"The size of the file in bytes.","schema":{"type":"string"}}],"responses":{"200":{"description":"Get generated signed upload url","content":{"application/json":{"examples":{"200 - Get generated signed upload url":{"value":{"headers":{"Content-Type":"image/png"},"method":"PUT","url":"https://bitrise-storage.com/apps/632d90ae-9e6a-4211-901d-971de7645c0c/app_icon/9a35afac-81a4-488d-a986-3c13015d70a0/icon.png?signed-url-data"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"examples":{"400 - when app_id parameter is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: app_id"}},"400 - when file name parameter is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: file_name"}},"400 - when file size bytes parameter is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: file_size_bytes"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}}},"/{id}":{"delete":{"summary":"Deletes an app","description":"Deletes an app - only workspace owner can do this, needs standard license for the app.","operationId":"DeleteApp","security":[{"token":[]}],"tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Delete app","content":{"application/json":{"examples":{"204 - Delete app":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"get":{"summary":"Gets an app","description":"Gives back an app your user has access to for the workspace.","operationId":"GetApp","security":[{"token":[]}],"tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"App","content":{"application/json":{"examples":{"200 - App":{"value":{"id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","created_at":"2025-02-11T09:26:01.000Z","platform":"android","project_id":"af19c6dc-530f-41cf-b6bd-6685986c077a","workspace_slug":"workspace-slug","icon_id":"dd6fadd2-6e4b-4bda-b6e2-aa319cdc89cd","icon_url":"https://storage.googleapis.com/rm-public-assets-storage/apps/f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de/app_icon/dd6fadd2-6e4b-4bda-b6e2-aa319cdc89cd/icon.png","app_name":"Test Android App","current_user_release_management_admin":false,"framework":null,"latest_version":null,"latest_version_date":null,"latest_build_version":"","latest_build_version_code":"","license":"basic","store_app_id":"io.bitrise.test","store_connected":true,"store_credential_id":null}}}}}},"404":{"description":"App not found","content":{"application/json":{"examples":{"404 - App not found":{"value":{"code":"ERR_NOT_FOUND","message":"Connected app: 'f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de' not found"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"patch":{"summary":"Updates an app","description":"Updates an app.","operationId":"UpdateApp","security":[{"token":[]}],"tags":["Apps"],"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier for your app.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The updated app","content":{"application/json":{"examples":{"200 - The updated app":{"value":{"id":"50590a63-799c-4bc7-99e2-c3b2363b22d1","created_at":"2025-02-11T09:26:01.000Z","platform":"android","project_id":"23c9f973-6b65-4aca-945b-a6eb4a0a9913","workspace_slug":"workspace-slug","icon_id":"dd6fadd2-6e4b-4bda-b6e2-aa319cdc89cd","icon_url":"https://storage.googleapis.com/rm-public-assets-storage/apps/50590a63-799c-4bc7-99e2-c3b2363b22d1/app_icon/dd6fadd2-6e4b-4bda-b6e2-aa319cdc89cd/icon.png","app_name":"Test Android App","current_user_release_management_admin":false,"framework":null,"latest_version":null,"latest_version_date":null,"latest_build_version":"","latest_build_version_code":"","license":"basic","store_app_id":"android.app.name","store_connected":true,"store_credential_id":null}}}}}},"400":{"description":"Invalid store credential id","content":{"application/json":{"examples":{"400 - Invalid store credential id":{"value":{"code":"ERR_INVALID_STORE_CREDENTIAL_ID","message":"The given store_credential_id is invalid."}}}}}},"404":{"description":"Store app id cannot be found in Store","content":{"application/json":{"examples":{"404 - Store app id cannot be found in Store":{"value":{"code":"ERR_PACKAGE_NAME_NOT_FOUND","message":"Package name cannot be found in Google Play Console."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"connect_to_store":{"description":"If true, will check app validity against the Apple App Store or Google Play Store (dependent on the platform of your app).\nThis means, that the already set or just given store_app_id will be validated against the Store, using the already set or just given store credential id.","type":"boolean"},"store_app_id":{"description":"The store identifier for your app. You can change the previously set store_app_id to match the one in the App Store or Google Play depending on the app platform. \nThis is especially useful if you want to connect your app with the store as the system willvalidate the given store_app_id against the Store.\n- In case of iOS platform it is the bundle id. Check the [property description](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleidentifier).\n- In case of Android platform it is the package name. Check the [documentation](https://developer.android.com/build/configure-app-module#set_the_application_id).","type":"string"},"store_credential_id":{"description":"If you have credentials added on Bitrise, you can decide to select one for your app. \n- In case of iOS platform it will be an Apple API credential id.\n- In case of Android platform it will be a Google Service credential id.","type":"string"}}}}}}}}},"servers":[{"url":"{baseURL}/release-management/v2/apps/v1","variables":{"baseURL":{"default":"https://api.bitrise.io","description":"The server base URL with the scheme."}}}],"components":{"securitySchemes":{"token":{"type":"apiKey","in":"header","description":"PAT necessary to use API calls","name":"authorization"}}},"tags":[{"name":"Apps","description":"Available in the Basic plan."},{"name":"Public Assets","description":"Available in the Basic plan."},{"name":"Installable Artifacts","description":"Available in the Basic plan."},{"name":"Presets","description":"Only available in the Standard plan."},{"name":"Apple App Store","description":"Only available in the Standard plan."}]} \ No newline at end of file diff --git a/api/bitrise-rm-build-distributions.json b/api/bitrise-rm-build-distributions.json new file mode 100644 index 00000000..7ad6a5e3 --- /dev/null +++ b/api/bitrise-rm-build-distributions.json @@ -0,0 +1 @@ +{"openapi":"3.0.1","info":{"title":"Release Management API - Build Distributions","version":"v2.1","description":"**Looking for the old API?** You can find it here: V1 API spec\n\nThe old API will be deprecated on February 1st 2027. Make sure that you have migrated to the new API before then.\n\nView the V1 → V2 Migration Guide"},"externalDocs":{"description":"API Changelog (json format)","url":"https://storage.googleapis.com/bitrise-release-management-public-api-docs/changelog_v2_build_distributions.json"},"paths":{"/":{"get":{"summary":"Gets the list of the build distribution versions.","description":"Gives back a list of build distributions versions.","operationId":"ListBuildDistributions","security":[{"token":[]}],"tags":["Build Distributions"],"parameters":[{"name":"app_id","in":"query","required":true,"description":"The uuidV4 identifier of the app the build distribution is connected to.","schema":{"type":"string"}},{"name":"items_per_page","in":"query","required":false,"schema":{"default":10,"maximum":50,"minimum":1,"type":"integer"},"description":"Specifies the maximum number of build distribution versions returned per request."},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer"},"description":"Specifies which page should be returned from the whole result set in a paginated scenario."}],"responses":{"200":{"description":"Build distributions","content":{"application/json":{"examples":{"200 - Build distributions":{"value":{"items":[{"name":"3.2"},{"name":"3.1"},{"name":"3.0"},{"name":"2.4"},{"name":"2.3"},{"name":"2.2"},{"name":"2.1"},{"name":"2.0"},{"name":"1.3"},{"name":"1.2"}],"count":13}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}}},"/test-builds":{"get":{"summary":"Gets a list of test builds","description":"Gives back a list of test builds for the given build distribution version.","security":[{"token":[]}],"tags":["Build Distributions"],"operationId":"ListTestBuilds","parameters":[{"name":"app_id","in":"query","required":true,"description":"The uuidV4 identifier of the app the tester group is connected to.","schema":{"type":"string"}},{"name":"version","in":"query","required":true,"description":"The version of the build distribution.","schema":{"type":"string"}},{"name":"items_per_page","in":"query","required":false,"schema":{"default":10,"maximum":50,"minimum":1,"type":"integer"},"description":"Specifies the maximum number of test builds returned per request."},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer"},"description":"Specifies which page should be returned from the whole result set in a paginated scenario."}],"responses":{"200":{"description":"Test builds","content":{"application/json":{"examples":{"200 - Test builds":{"value":{"items":[{"app_name":"IOS app title","branch":"master","build_number":"112","build_slug":"build-slug","created_at":"2025-02-11T09:26:01.000Z","download_url":"https://download.url","filename_ext":".ipa","filename":"test_build_1.ipa","id":"d9a69b7a-8a0a-4ce0-8802-cc5c7bf0d6eb","public_install_page_url":null,"platform":"ios","signature":"enterprise","source":"ci","storage_provider":"gcs","store_app_id":"io.bitrise.ios","type":"ipa","formatted_version":"1.2.3 (123456)","version":"1.2.3","version_code":"123456","workflow":"primary"},{"app_name":"IOS app title","branch":null,"build_number":"112","build_slug":null,"created_at":"2025-02-11T09:26:01.000Z","download_url":"https://download.url","filename_ext":".ipa","filename":"test_build_2.ipa","id":"0bae7f60-9823-43f5-b5ef-be07d43eb6ae","public_install_page_url":null,"platform":"ios","signature":"development","source":"api","storage_provider":"gcs","store_app_id":"io.bitrise.ios.example","type":"ipa","formatted_version":"1.2.3 (123457)","version":"1.2.3","version_code":"123457","workflow":null},{"app_name":"IOS app title","branch":"master","build_number":"112","build_slug":"build-slug","created_at":"2025-02-11T09:26:01.000Z","download_url":"https://download.url","filename_ext":".ipa","filename":"test_build_3.ipa","id":"2316c477-ce65-408c-978d-e0dfd9cf0bc6","public_install_page_url":null,"platform":"ios","signature":"ad-hoc","source":"ci","storage_provider":"gcs","store_app_id":"io.bitrise.ios","type":"ipa","formatted_version":"1.2.3 (123458)","version":"1.2.3","version_code":"123458","workflow":"primary"}],"pagination":{"current_page":1,"items_per_page":10,"has_next_page":false,"total_count":3}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}}},"/tester-groups":{"get":{"summary":"Gets a list of tester groups","description":"Gives back a list of tester groups for the app. The `type` query parameter selects which groups are returned: `internal` (the default, Bitrise users) or `external` (email-only testers). For example, `?type=external` returns only the external tester groups.","security":[{"token":[]}],"tags":["Tester Groups"],"operationId":"ListTesterGroups","parameters":[{"name":"app_id","in":"query","required":true,"description":"The uuidV4 identifier of the app the tester group is connected to.","schema":{"type":"string"}},{"name":"items_per_page","in":"query","required":false,"schema":{"default":10,"maximum":50,"minimum":1,"type":"integer"},"description":"Specifies the maximum number of tester groups returned per request."},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer"},"description":"Specifies which page should be returned from the whole result set in a paginated scenario."},{"name":"type","in":"query","required":false,"schema":{"enum":["internal","external"],"type":"string"},"description":"Tester type. Defaults to internal."},{"name":"installable_artifact_id","in":"query","required":false,"description":"When provided, each tester group is decorated with `notification_sent` (whether a notification for this artifact has already been sent to the group) and, for external tester groups, `custom_access_link` (the access link sent to the testers: id, name, url, expires_at, access_code; omitted when there is none). The access code is not exposed via the public API.","schema":{"type":"string"}}],"responses":{"200":{"description":"External tester groups","content":{"application/json":{"examples":{"200 - Tester groups":{"value":{"items":[{"id":"d4267035-b75a-450c-b46f-34cad2706a75","name":"Internal Group 1","type":"internal","auto_notify":false,"notification_types":{"email":{"enabled":true}},"tester_count":3,"enabled_notification_types":["email"]},{"id":"a4051ba6-0d4a-400c-bd33-b34fcdf92f93","name":"Internal Group 2","type":"internal","auto_notify":true,"notification_types":{"email":{"enabled":true}},"tester_count":2,"enabled_notification_types":["email"]}],"pagination":{"total_count":2,"current_page":1,"items_per_page":10}}},"200 - Tester groups decorated with notification details":{"value":{"items":[{"id":"b2d3a94c-ae53-4ae9-8de3-39968cf642cf","name":"External Group","type":"external","auto_notify":false,"notification_types":{"email":{"enabled":true}},"tester_count":0,"enabled_notification_types":["email"],"notification_sent":true,"custom_access_link":{"id":"c0ffee00-0000-0000-0000-000000000001","name":"External Group","url":"https://app.bitrise.io/app-install/example-token","expires_at":"2026-07-24T12:00:00.000Z"}}],"pagination":{"total_count":1,"current_page":1,"items_per_page":10}}},"200 - External tester groups":{"value":{"items":[{"id":"0587a94c-ae53-4ae9-8de3-39968cf642cf","name":"External Group","type":"external","auto_notify":false,"notification_types":{"email":{"enabled":true}},"tester_count":0,"enabled_notification_types":["email"]}],"pagination":{"total_count":1,"current_page":1,"items_per_page":10}}}}}}},"400":{"description":"Invalid type value","content":{"application/json":{"examples":{"400 - Invalid type value":{"value":{"code":"ERR_VALIDATION","message":"Invalid type: `not-a-valid-type`. Valid values are: internal, external."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"post":{"summary":"Creates a tester group","description":"Creates a tester group for the app. Without a `type` (or with `type=internal`) an internal group of Bitrise users is created. With `type=external` an external group of email-only testers is created: provide a non-empty `emails` array (at most 1000 addresses, each at most 255 characters, syntactically validated) and a tester is created for every address and added to the group. The `emails` field is ignored for internal groups. For example, create an external group with `?type=external` and body `{ \"app_id\": \"\", \"name\": \"My external testers\", \"emails\": [\"tester1@example.com\", \"tester2@example.com\"] }`.","operationId":"CreateTesterGroup","security":[{"token":[]}],"tags":["Tester Groups"],"parameters":[{"name":"type","in":"query","required":false,"schema":{"enum":["internal","external"],"type":"string"},"description":"Tester type. Defaults to internal."}],"responses":{"201":{"description":"External tester group","content":{"application/json":{"examples":{"201 - The created tester group":{"value":{"id":"5eb36231-b162-4c16-8c2c-02a0ab1bb05f","name":"My favorite tester group","type":"internal","auto_notify":true,"notification_types":{"email":{"enabled":true}},"tester_count":0,"enabled_notification_types":["email"]}},"201 - External tester group":{"value":{"id":"7f3c1b2a-9d4e-4c6a-8b1f-2e5d6c7a8b9c","name":"My external testers","type":"external","auto_notify":false,"notification_types":{"email":{"enabled":true}},"tester_count":2,"enabled_notification_types":["email"]}}}}}},"400":{"description":"Invalid type value","content":{"application/json":{"examples":{"400 - Parameter missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: name"}},"400 - External group without emails":{"value":{"code":"ERR_VALIDATION","message":"At least one email is required for an external tester group."}},"400 - External group with invalid emails":{"value":{"code":"ERR_VALIDATION","message":"Some of the provided emails are invalid.","details":{"invalid_emails":["nope"]}}},"400 - Invalid type value":{"value":{"code":"ERR_VALIDATION","message":"Invalid type: `not-a-valid-type`. Valid values are: internal, external."}}}}}},"422":{"description":"Tester group name has already taken.","content":{"application/json":{"examples":{"422 - Tester group name has already taken.":{"value":{"code":"ERR_UNPROCESSABLE_ENTITY","message":"Validation failed: Name has already been taken"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to create tester group. Only Admins, Owners and Workspace Admins can create new tester groups."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"app_id":{"description":"An uuidV4 identifier for your app.","type":"string"},"name":{"description":"The name of the new tester group. Should be unique in the scope of the app.","type":"string","example":"My favorite tester group"},"auto_notify":{"description":"If set to true it indicates the tester group will receive notifications automatically.","type":"boolean"},"emails":{"description":"Email addresses added as external testers to the group. Required for external tester groups (at least one, at most 1000, each at most 255 characters). Ignored for internal tester groups.","type":"array","maxItems":1000,"items":{"type":"string","maxLength":255,"example":"tester@example.com"}}},"required":["app_id","name"]}}}}}},"/tester-groups/{id}":{"delete":{"summary":"Deletes a tester group","description":"Deletes a tester group. For external tester groups, any external tester that is left without membership in any group is also removed; internal testers are always kept. The `type` query parameter must match the group's type.","operationId":"DeleteTesterGroup","security":[{"token":[]}],"tags":["Tester Groups"],"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the tester group.","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"enum":["internal","external"],"type":"string"},"description":"Tester type. Defaults to internal."}],"responses":{"204":{"description":"Delete tester group","content":{"application/json":{"examples":{"204 - Delete tester group":{"value":{}}}}}},"400":{"description":"Tester type mismatch","content":{"application/json":{"examples":{"400 - Invalid type value":{"value":{"code":"ERR_VALIDATION","message":"Invalid type: `not-a-valid-type`. Valid values are: internal, external."}},"400 - Tester type mismatch":{"value":{"code":"ERR_VALIDATION","message":"The resource is of type `internal` and cannot be accessed with type `external`."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to destroy the tester group. Only Admins, Owners and Workspace Admins can destroy tester groups."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"get":{"summary":"Gets Tester group details","description":"Gives back the details of the selected tester group. The `type` query parameter must match the group's type (`internal` by default, or `external`); for example, use `?type=external` to fetch an external group. A non-matching type returns a validation error.","operationId":"GetTesterGroup","security":[{"token":[]}],"tags":["Tester Groups"],"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the tester group.","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"enum":["internal","external"],"type":"string"},"description":"Tester type. Defaults to internal."}],"responses":{"200":{"description":"External tester group","content":{"application/json":{"examples":{"200 - Tester group":{"value":{"id":"6506b9dd-6cce-49e2-83ce-5aadd918b0aa","name":"Tester Group Example","type":"internal","auto_notify":false,"notification_types":{"email":{"enabled":true}},"tester_count":0,"enabled_notification_types":["email"]}},"200 - External tester group":{"value":{"id":"cd3623be-c61b-4e4f-8eec-5ae267056d7f","name":"External Group Example","type":"external","auto_notify":false,"notification_types":{"email":{"enabled":true}},"tester_count":0,"enabled_notification_types":["email"]}}}}}},"400":{"description":"Tester type mismatch","content":{"application/json":{"examples":{"400 - Invalid type value":{"value":{"code":"ERR_VALIDATION","message":"Invalid type: `not-a-valid-type`. Valid values are: internal, external."}},"400 - Tester type mismatch":{"value":{"code":"ERR_VALIDATION","message":"The resource is of type `internal` and cannot be accessed with type `external`."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"put":{"summary":"Updates tester group","description":"Updates the given tester group. Internal tester groups can update their `name` and `auto_notify`. External tester groups have no `auto_notify`, so for them this endpoint only renames the group (any `auto_notify` value sent is ignored). The `type` query parameter must match the group's type.","operationId":"UpdateTesterGroup","security":[{"token":[]}],"tags":["Tester Groups"],"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the tester group.","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"enum":["internal","external"],"type":"string"},"description":"Tester type. Defaults to internal."}],"responses":{"200":{"description":"External tester group","content":{"application/json":{"examples":{"200 - Tester group":{"value":{"id":"70241777-dafa-44a6-ae22-0548d7953e8d","name":"My favorite tester group NEW","type":"internal","auto_notify":true,"notification_types":{"email":{"enabled":true}},"tester_count":0,"enabled_notification_types":["email"]}},"200 - External tester group":{"value":{"id":"6d45127a-5d53-451d-9aa5-4ed3b45144f1","name":"External Group NEW","type":"external","auto_notify":false,"notification_types":{"email":{"enabled":true}},"tester_count":0,"enabled_notification_types":["email"]}}}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"examples":{"422 - Unprocessable entity":{"value":{"code":"ERR_UNPROCESSABLE_ENTITY","message":"Validation failed: Name has already been taken"}}}}}},"400":{"description":"Tester type mismatch","content":{"application/json":{"examples":{"400 - Invalid type value":{"value":{"code":"ERR_VALIDATION","message":"Invalid type: `not-a-valid-type`. Valid values are: internal, external."}},"400 - Tester type mismatch":{"value":{"code":"ERR_VALIDATION","message":"The resource is of type `internal` and cannot be accessed with type `external`."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to update the tester group. Only Admins, Owners and Workspace Admins can update tester groups."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"My favorite tester group NEW","description":"The new name of the tester group. Should be unique in the scope of the app."},"auto_notify":{"type":"boolean","description":"If set to true it indicates the tester group will receive notifications automatically."}}}}}}}},"/tester-groups/{id}/add-testers":{"post":{"summary":"Add testers to a tester group","description":"Adds testers to a tester group for the app. For internal groups provide `user_slugs` (Bitrise users); for external groups (`type=external`) provide an `emails` array (at most 1000) and a tester is created/reused for each address. The array that does not match the group type is ignored.","operationId":"AddTestersToTesterGroup","security":[{"token":[]}],"tags":["Tester Groups"],"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the tester group.","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"enum":["internal","external"],"type":"string"},"description":"Tester type. Defaults to internal."}],"responses":{"200":{"description":"Add external testers","content":{"application/json":{"examples":{"200 - Add tester(s)":{"value":{"errors":{}}},"200 - Add testers for the valid slugs only":{"value":{"errors":{"invalid-slug":"User not found."}}},"200 - Add external testers":{"value":{"errors":{}}}}}}},"400":{"description":"Tester type mismatch","content":{"application/json":{"examples":{"400 - Parameter missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: user_slugs"}},"400 - Invalid external emails":{"value":{"code":"ERR_VALIDATION","message":"Some of the provided emails are invalid.","details":{"invalid_emails":["nope"]}}},"400 - Invalid type value":{"value":{"code":"ERR_VALIDATION","message":"Invalid type: `not-a-valid-type`. Valid values are: internal, external."}},"400 - Tester type mismatch":{"value":{"code":"ERR_VALIDATION","message":"The resource is of type `internal` and cannot be accessed with type `external`."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to add testers to the tester group. Only Admins, Owners and Workspace Admins can add new testers to the tester groups."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_slugs":{"description":"User slugs to add as internal testers. Required for internal tester groups; ignored for external groups.","type":"array","items":{"type":"string","example":"user-slug-1"}},"emails":{"description":"Email addresses to add as external testers. Required for external tester groups (at most 1000); ignored for internal groups.","type":"array","items":{"type":"string","example":"tester@example.com"}}}}}}}}},"/tester-groups/{id}/notify":{"post":{"summary":"Notify the tester group","description":"Notify an internal tester group about a new test build. To notify external tester groups, use the custom access link creation endpoint with tester_group_id.","operationId":"NotifyTesterGroup","security":[{"token":[]}],"tags":["Tester Groups"],"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the tester group.","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"enum":["internal","external"],"type":"string"},"description":"Tester type. Defaults to internal."}],"responses":{"204":{"description":"Send notification","content":{"application/json":{"examples":{"204 - Send notification":{"value":{}}}}}},"400":{"description":"Tester type mismatch","content":{"application/json":{"examples":{"400 - External tester group":{"value":{"code":"ERR_VALIDATION","message":"External tester groups cannot be notified via this endpoint. Create a custom access link with tester_group_id to notify them."}},"400 - Parameter missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: test_build_id"}},"400 - Test build cannot be found":{"value":{"code":"ERR_VALIDATION","message":"The provided artifact cannot be used for tester group notifications, id: `e8469a17-5fe8-4d59-abad-52fc8a94e729`"}},"400 - Test build type is not supported":{"value":{"code":"ERR_VALIDATION","message":"The provided artifact cannot be used for tester group notifications, id: `b6690148-4e1f-4d66-a554-d25c24397a42`"}},"400 - Test build is not distribution ready":{"value":{"code":"ERR_VALIDATION","message":"The provided artifact cannot be used for tester group notifications, id: `dde4bfd4-c9c3-4fb8-bb1c-85b34aaf8da9`"}},"400 - Invalid type value":{"value":{"code":"ERR_VALIDATION","message":"Invalid type: `not-a-valid-type`. Valid values are: internal, external."}},"400 - Tester type mismatch":{"value":{"code":"ERR_VALIDATION","message":"The resource is of type `internal` and cannot be accessed with type `external`."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to notify the tester group. Only Admins, Owners and Workspace Admins can send notifications to the tester groups."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"test_build_id":{"description":"The unique identifier of the test build what will be sent in the notification of the tester group.","type":"string","example":"test-build-id"}},"required":["test_build_id"]}}}}}},"/tester-groups/{id}/potential-testers":{"get":{"summary":"Gets a list of potential tester candidates to the tester groups","description":"Gives back a paginated list of tester candidates.","operationId":"ListPotentialTesters","security":[{"token":[]}],"tags":["Tester Groups"],"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the tester group.","required":true,"schema":{"type":"string"}},{"name":"items_per_page","in":"query","required":false,"schema":{"default":30,"minimum":1,"type":"integer"},"description":"Specifies the maximum number of potential testers that this route will return for a page."},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer"},"description":"Specifies which page should be returned from the whole result set in a paginated scenario."},{"name":"search","in":"query","required":false,"schema":{"type":"string"},"description":"Searches for potential testers based on email or username, using a case-insensitive starts with search."},{"name":"type","in":"query","required":false,"schema":{"enum":["internal","external"],"type":"string"},"description":"Tester type. Defaults to internal."}],"responses":{"200":{"description":"Potential Testers","content":{"application/json":{"examples":{"200 - Potential Testers":{"value":{"total_count":3,"items":[{"email":"default-user@example.com","slug":"default-user-slug","username":"default-user","already_member":false},{"email":"need-to-find-this@example.com","slug":"need-to-find-this-slug","username":"need-to-find-this","already_member":true},{"email":"user2@bitrise.io","slug":"user2-slug","username":"user2","already_member":false}]}},"200 - when items_per_page param is sent":{"value":{"total_count":3,"items":[{"email":"default-user@example.com","slug":"default-user-slug","username":"default-user","already_member":false}]}},"200 - when search param is sent":{"value":{"total_count":1,"items":[{"email":"need-to-find-this@example.com","slug":"need-to-find-this-slug","username":"need-to-find-this","already_member":true}]}}}}}},"400":{"description":"Tester type mismatch","content":{"application/json":{"examples":{"400 - Invalid type value":{"value":{"code":"ERR_VALIDATION","message":"Invalid type: `not-a-valid-type`. Valid values are: internal, external."}},"400 - Tester type mismatch":{"value":{"code":"ERR_VALIDATION","message":"The resource is of type `internal` and cannot be accessed with type `external`."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to list the potential testers. Only Admins, Owners and Workspace Admins can list the potential testers."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}}},"/testers":{"get":{"summary":"Gets a list of testers","description":"Gives back a list of testers.","operationId":"ListTesters","security":[{"token":[]}],"tags":["Testers"],"parameters":[{"name":"app_id","in":"query","required":true,"description":"The uuidV4 identifier of the app the tester group is connected to.","schema":{"type":"string"}},{"name":"tester_group_id","in":"query","required":false,"description":"The uuidV4 identifier of a tester group.","schema":{"type":"string"}},{"name":"items_per_page","in":"query","required":false,"schema":{"default":10,"maximum":50,"minimum":1,"type":"integer"},"description":"Specifies the maximum number of testers returned per request."},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer"},"description":"Specifies which page should be returned from the whole result set in a paginated scenario."},{"name":"type","in":"query","required":false,"schema":{"enum":["internal","external"],"type":"string"},"description":"Tester type. Defaults to internal."}],"responses":{"200":{"description":"List of testers","content":{"application/json":{"examples":{"200 - Testers of the connected app":{"value":{"items":[{"slug":"user-slug1","username":"user-name1","email":"user@example.com","tester_groups_count":2},{"slug":"user-slug2","username":"user-name2","email":"user2@example.com","tester_groups_count":1}],"pagination":{"total_count":2,"current_page":1,"items_per_page":10}}},"200 - Testers of the tester group":{"value":{"items":[{"slug":"user-slug1","username":"user-name1","email":"user@example.com","tester_groups_count":1}],"pagination":{"total_count":1,"current_page":1,"items_per_page":10}}},"200 - External testers":{"value":{"items":[{"slug":"external@example.com","username":null,"email":"external@example.com","tester_groups_count":1}],"pagination":{"total_count":1,"current_page":1,"items_per_page":10}}}}}}},"400":{"description":"Invalid type value","content":{"application/json":{"examples":{"400 - Invalid type value":{"value":{"code":"ERR_VALIDATION","message":"Invalid type: `not-a-valid-type`. Valid values are: internal, external."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}}},"/testers/{tester_slug}":{"delete":{"summary":"Deletes a tester","description":"Deletes a tester. This means that the endpoint will delete the specified tester from all tester groups in Build Distribution. In case you only want to delete the tester from a specific tester group use the optional tester_group_id parameter.","operationId":"DeleteTester","security":[{"token":[]}],"tags":["Testers"],"parameters":[{"name":"app_id","in":"query","required":true,"description":"The uuidV4 identifier of the app the tester group is connected to.","schema":{"type":"string"}},{"name":"tester_slug","in":"path","description":"The slug of the tester.","required":true,"schema":{"type":"string"}},{"name":"tester_group_id","in":"query","required":false,"description":"The uuidV4 identifier of a tester group. In case it is given, the specified tester will only be deleted from this specific tester group.","schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"enum":["internal","external"],"type":"string"},"description":"Tester type. Defaults to internal."}],"responses":{"204":{"description":"Delete the tester","content":{"application/json":{"examples":{"204 - Delete the tester from the connected app":{"value":{}},"204 - Delete tester from the tester group":{"value":{}},"204 - Delete an external tester by email":{"value":{}}}}}},"400":{"description":"Tester type mismatch","content":{"application/json":{"examples":{"400 - Invalid type value":{"value":{"code":"ERR_VALIDATION","message":"Invalid type: `not-a-valid-type`. Valid values are: internal, external."}},"400 - Tester type mismatch":{"value":{"code":"ERR_VALIDATION","message":"The resource is of type `internal` and cannot be accessed with type `external`."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}}}},"servers":[{"url":"{baseURL}/release-management/v2/build-distributions/v1","variables":{"baseURL":{"default":"https://api.bitrise.io","description":"The server base URL with the scheme."}}}],"components":{"securitySchemes":{"token":{"type":"apiKey","in":"header","description":"PAT necessary to use API calls","name":"authorization"}}},"tags":[{"name":"Build Distributions","description":"Available in the Basic plan."},{"name":"Tester Groups","description":"Available in the Basic plan."},{"name":"Testers","description":"Available in the Basic plan."}]} \ No newline at end of file diff --git a/api/bitrise-rm-code-push.json b/api/bitrise-rm-code-push.json new file mode 100644 index 00000000..d3dc2512 --- /dev/null +++ b/api/bitrise-rm-code-push.json @@ -0,0 +1 @@ +{"openapi":"3.0.1","info":{"title":"Release Management API - CodePush","version":"v2.1","description":"**Looking for the old API?** You can find it here: V1 API spec\n\nThe old API will be deprecated on February 1st 2027. Make sure that you have migrated to the new API before then.\n\nView the V1 → V2 Migration Guide"},"externalDocs":{"description":"API Changelog (json format)","url":"https://storage.googleapis.com/bitrise-release-management-public-api-docs/changelog_v2_code_push.json"},"paths":{"/deployments":{"get":{"summary":"List deployments","description":"Gets a list of deployments for the given app.","security":[{"token":[]}],"tags":["Deployments"],"operationId":"ListCodePushDeployments","parameters":[{"name":"app_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List the deployments","content":{"application/json":{"examples":{"200 - List the deployments":{"value":{"items":[{"id":"9a35afac-81a4-488d-a986-3c13015d70a0","name":"Example deployment","created_at":"2025-02-06T09:26:01.000Z","updated_at":"2025-02-06T09:26:01.000Z","number_of_updates":13,"key":"random_generated_base64_key"}],"pagination":{"total_count":1,"current_page":1,"items_per_page":10}}}}}}},"400":{"description":"Bad request - The provided release management id is invalid","content":{"application/json":{"examples":{"400 - Bad request - The provided release management id is invalid":{"value":{"code":"ERR_INVALID_UUID","message":"The given connected app id is not a uuid: invalid."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"post":{"summary":"Creates a deployment","description":"Creates a deployment under the given app.","security":[{"token":[]}],"tags":["Deployments"],"operationId":"CreateCodePushDeployment","parameters":[],"responses":{"201":{"description":"The created deployment","content":{"application/json":{"examples":{"201 - The created deployment":{"value":{"id":"9a35afac-81a4-488d-a986-3c13015d70a0","name":"Example deployment","created_at":"2025-02-11T09:26:01.000Z","updated_at":"2025-02-11T09:26:01.000Z","number_of_updates":0,"key":"random_generated_base64_key"}}}}}},"400":{"description":"Bad request - Invalid deployment key","content":{"application/json":{"examples":{"400 - Bad request - The provided uuid is invalid":{"value":{"code":"ERR_INVALID_UUID","message":"The given connected app id is not a uuid: invalid."}},"400 - Bad request - The name is required":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: name"}},"400 - Bad request - Invalid deployment key":{"value":{"code":"ERR_VALIDATION","message":"invalid deployment key"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of your deployment."},"key":{"type":"string","description":"The secret key of the deployment. If not provided we will generate it."},"app_id":{"type":"string","description":"The uuidV4 identifier of the app."}},"required":["name","app_id"]}}}}}},"/deployments/{id}":{"delete":{"summary":"Deletes a deployment","description":"Deletes a deployment.","operationId":"DeleteDeployment","security":[{"token":[]}],"tags":["Deployments"],"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the deployment.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Delete the deployment","content":{"application/json":{"examples":{"204 - Delete the deployment":{"value":{}}}}}},"400":{"description":"Bad request - The provided deployment id is invalid","content":{"application/json":{"examples":{"400 - Bad request - The provided deployment id is invalid":{"value":{"code":"ERR_INVALID_UUID","message":"the provided uuid is invalid"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"get":{"summary":"Gets a deployment","description":"Gets a deployment with the given identifier.","security":[{"token":[]}],"tags":["Deployments"],"operationId":"GetCodePushDeployment","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get the deployment","content":{"application/json":{"examples":{"200 - when user can create connected apps":{"value":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"Example deployment","created_at":"2025-02-06T09:26:01.000Z","updated_at":"2025-02-06T09:26:01.000Z","number_of_updates":13,"key":"random_generated_base64_key","package":{"app_version":"1.3.0","id":"123e4567-e89b-12d3-a456-426614174000","label":"123e4567-e89b-12d3-a456-426614174000","mandatory":true,"release_method":"Upload","release_time":"2025-02-06T09:26:01.000Z","rollout":100},"update":{"app_version":"1.3.0","id":"123e4567-e89b-12d3-a456-426614174000","label":"123e4567-e89b-12d3-a456-426614174000","mandatory":true,"release_method":"Upload","release_time":"2025-02-06T09:26:01.000Z","rollout":100}}},"200 - when there are no packages for the deployment":{"value":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"Example deployment","created_at":"2025-02-06T09:26:01.000Z","updated_at":"2025-02-06T09:26:01.000Z","number_of_updates":13,"key":"random_generated_base64_key"}},"200 - when user cannot create connected app":{"value":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"Example deployment","created_at":"2025-02-06T09:26:01.000Z","updated_at":"2025-02-06T09:26:01.000Z","number_of_updates":13,"package":{"app_version":"1.3.0","id":"123e4567-e89b-12d3-a456-426614174000","label":"123e4567-e89b-12d3-a456-426614174000","mandatory":true,"release_method":"Upload","release_time":"2025-02-06T09:26:01.000Z","rollout":100},"update":{"app_version":"1.3.0","id":"123e4567-e89b-12d3-a456-426614174000","label":"123e4567-e89b-12d3-a456-426614174000","mandatory":true,"release_method":"Upload","release_time":"2025-02-06T09:26:01.000Z","rollout":100}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"examples":{"400 - Bad request":{"value":{"code":"ERR_INVALID_UUID","message":"The given deployment id is not a uuid: invalid."}}}}}},"404":{"description":"Deployment not found","content":{"application/json":{"examples":{"404 - Deployment not found":{"value":{"code":"ERR_NOT_FOUND","message":"cannot find deployment for the provided uuid"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"patch":{"summary":"Updates a deployment","description":"Updates a deployment.","security":[{"token":[]}],"tags":["Deployments"],"operationId":"UpdateCodePushDeployment","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Update deployment","content":{"application/json":{"examples":{"201 - Update deployment":{"value":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"New deployment name","created_at":"2025-02-11T09:26:01.000Z","updated_at":"2025-02-11T09:26:01.000Z","number_of_updates":0,"key":"random_generated_base64_key"}}}}}},"400":{"description":"Bad request - The name is required","content":{"application/json":{"examples":{"400 - Bad request - The provided deployment id is invalid":{"value":{"code":"ERR_INVALID_UUID","message":"the provided uuid is invalid"}},"400 - Bad request - The name is required":{"value":{"code":"ERR_VALIDATION","message":"name is required"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The new name of the deployment"}}}}}}}},"/deployments/{id}/promote":{"post":{"summary":"Promote a package.","description":"Promote a package from the source to the destination deployment.","security":[{"token":[]}],"tags":["Deployments"],"operationId":"PromoteCodePushPackage","parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the source deployment.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Promote package","content":{"application/json":{"examples":{"201 - Promote package":{"value":{"app_version":"1.3.0","created_at":"2025-02-06T09:26:01.000Z","created_by":{"id":"default-user-slug","email":"default-user@example.com","username":"default-user","avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"},"deployment_id":"72a1ff34-67b6-470c-a095-27381bbe8904","description":"Description","disabled":"false","file_name":"main.jsbundle","file_size_bytes":13,"hash":"package_hash","id":"123e4567-e89b-12d3-a456-426614174000","label":"123e4567-e89b-12d3-a456-426614174000","mandatory":"true","rollout":"99","update_version":"v13","updated_at":"2025-02-06T09:26:01.000Z","updated_by":{"id":"default-user-slug","email":"default-user@example.com","username":"default-user","avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"},"signed":false}}}}}},"400":{"description":"Bad request - Validation error: invalid rollout","content":{"application/json":{"examples":{"400 - when target_deployment_id parameter is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: target_deployment_id"}},"400 - Bad request - The provided deployment id is invalid":{"value":{"code":"ERR_INVALID_UUID","message":"the provided uuid is invalid"}},"400 - Bad request - Validation error: invalid app_version":{"value":{"code":"ERR_VALIDATION","message":"validation error: field app_version failed on: semver"}},"400 - Bad request - Validation error: invalid rollout":{"value":{"code":"ERR_VALIDATION","message":"validation error: field rollout failed on: max (100)"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"target_deployment_id":{"type":"string","description":"The uuidV4 identifier of the target deployment."},"package_id":{"type":"string","description":"A uuidV4 identifier of the source package."},"app_version":{"type":"string","description":"The app version (e.g., 1.0.0) that this update targets."},"description":{"type":"string","description":"A description of the update to display in the release history."},"disabled":{"type":"string","description":"If set to true, disables the package immediately after upload."},"mandatory":{"type":"string","description":"If set to true, marks the update as mandatory for all users."},"rollout":{"type":"string","description":"The percentage (0–100) of users to gradually roll the update out to."}},"required":["target_deployment_id"]}}}}}},"/deployments/{id}/rollback":{"post":{"summary":"Rollback to the previous or a specific version.","description":"Rollback to the previous, or to a specific version if specified.","security":[{"token":[]}],"tags":["Deployments"],"operationId":"RollbackCodePushPackage","parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the deployment.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Rollback to a specific version","content":{"application/json":{"examples":{"201 - Rollback to the previous version":{"value":{"app_version":"1.3.0","created_at":"2025-02-06T09:26:01.000Z","created_by":{"id":"default-user-slug","email":"default-user@example.com","username":"default-user","avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"},"deployment_id":"123e4567-e89b-12d3-a456-426614174000","description":"Description","disabled":"false","file_name":"main.jsbundle","file_size_bytes":123456,"hash":"package_hash","id":"5093c888-3bf8-4c4b-a48e-bfc4d709ee68","label":"5093c888-3bf8-4c4b-a48e-bfc4d709ee68","mandatory":"true","rollout":"99","update_version":"v13","updated_at":"2025-02-06T09:26:01.000Z","updated_by":{"id":"default-user-slug","email":"default-user@example.com","username":"default-user","avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"},"signed":false}},"201 - Rollback to a specific version":{"value":{"app_version":"1.3.0","created_at":"2025-02-06T09:26:01.000Z","created_by":{"id":"default-user-slug","email":"default-user@example.com","username":"default-user","avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"},"deployment_id":"123e4567-e89b-12d3-a456-426614174000","description":"Description","disabled":"false","file_name":"main.jsbundle","file_size_bytes":123456,"hash":"package_hash","id":"5093c888-3bf8-4c4b-a48e-bfc4d709ee68","label":"5093c888-3bf8-4c4b-a48e-bfc4d709ee68","mandatory":"true","rollout":"99","update_version":"v13","updated_at":"2025-02-06T09:26:01.000Z","updated_by":{"id":"default-user-slug","email":"default-user@example.com","username":"default-user","avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"},"signed":false}}}}}},"400":{"description":"Bad request - The provided deployment id is invalid","content":{"application/json":{"examples":{"400 - Bad request - The provided deployment id is invalid":{"value":{"code":"ERR_INVALID_UUID","message":"the provided uuid is invalid"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"package_id":{"type":"string","description":"A uuidV4 identifier of the package to rollback to. Defaults to the previous version if omitted."}}}}}}}},"/metrics":{"get":{"summary":"Gets workspace level metrics","description":"Gets storage and MAU metrics of CodePush for the given Workspace.","operationId":"GetCodePushMetrics","security":[{"token":[]}],"tags":["Metrics"],"parameters":[{"name":"workspace_slug","in":"query","required":true,"description":"The unique identifier of the workspace.","schema":{"type":"string"}}],"responses":{"200":{"description":"Get metrics","content":{"application/json":{"examples":{"200 - Get metrics":{"value":{"data_transfer":0.28,"data_transfer_limit":125000,"storage":12.4,"storage_limit":25,"monthly_active_users":5000,"monthly_active_users_limit":100000,"cycle":{"start":"2025-10-06","end":"2025-11-06"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}}},"/updates":{"get":{"summary":"List updates","description":"Gets a list of updates for a given deployment.","security":[{"token":[]}],"tags":["Updates"],"operationId":"ListCodePushUpdates","parameters":[{"name":"deployment_id","in":"query","required":true,"description":"The uuidV4 identifier of the deployment.","schema":{"type":"string"}}],"responses":{"200":{"description":"List the updates","content":{"application/json":{"examples":{"200 - List the updates":{"value":{"items":[{"app_version":"1.3.0","created_at":"2025-02-06T09:26:01.000Z","created_by":{"id":"default-user-slug","email":"default-user@example.com","username":"default-user","avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"},"deployment_id":"deployment_id","description":"","disabled":false,"file_name":"main.jsbundle","file_size_bytes":13,"hash":"94b7659b8c6452b3734915a7ae01c7d24d3571fc9e2d0be3acd1b0a1b81bc6e8","id":"9a35afac-81a4-488d-a986-3c13015d70a0","label":"9a35afac-81a4-488d-a986-3c13015d70a0","mandatory":true,"rollout":100,"update_version":"v13","updated_at":"2025-02-06T09:26:01.000Z","updated_by":{"id":"default-user-slug","email":"default-user@example.com","username":"default-user","avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"},"signed":false}],"pagination":{"total_count":1,"current_page":1,"items_per_page":10}}}}}}},"400":{"description":"Bad request - The provided deployment id is invalid","content":{"application/json":{"examples":{"400 - Bad request - The provided deployment id is invalid":{"value":{"code":"ERR_INVALID_UUID","message":"the provided uuid is invalid"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}}},"/updates/{id}":{"delete":{"summary":"Deletes an update","description":"Deletes an update.","operationId":"DeleteUpdate","security":[{"token":[]}],"tags":["Updates"],"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the update.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Delete the update","content":{"application/json":{"examples":{"204 - Delete the update":{"value":{}}}}}},"400":{"description":"Bad request - The provided update id is invalid","content":{"application/json":{"examples":{"400 - Bad request - The provided update id is invalid":{"value":{"code":"ERR_INVALID_UUID","message":"The given update id is not a uuid: invalid."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"get":{"summary":"Gets an update","description":"Gets an update for the given deployment.","security":[{"token":[]}],"tags":["Updates"],"operationId":"GetCodePushUpdate","parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the update.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get the update","content":{"application/json":{"examples":{"200 - Get the update":{"value":{"app_version":"1.3.0","created_at":"2025-02-06T09:26:01.000Z","created_by":{"id":"default-user-slug","email":"default-user@example.com","username":"default-user","avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"},"deployment_id":"123e4567-e89b-12d3-a456-426614174000","description":"","disabled":false,"file_name":"main.jsbundle","file_size_bytes":13,"hash":"94b7659b8c6452b3734915a7ae01c7d24d3571fc9e2d0be3acd1b0a1b81bc6e8","id":"9a35afac-81a4-488d-a986-3c13015d70a0","label":"9a35afac-81a4-488d-a986-3c13015d70a0","mandatory":true,"rollout":100,"update_version":"v13","updated_at":"2025-02-06T09:26:01.000Z","updated_by":{"id":"default-user-slug","email":"default-user@example.com","username":"default-user","avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"},"signed":false}}}}}},"400":{"description":"Bad request","content":{"application/json":{"examples":{"400 - Bad request":{"value":{"code":"ERR_INVALID_UUID","message":"The given update id is not a uuid: invalid."}}}}}},"404":{"description":"Update not found","content":{"application/json":{"examples":{"404 - Update not found":{"value":{"code":"ERR_NOT_FOUND","message":"cannot find update for the provided uuid"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"patch":{"summary":"Patches an update","description":"Patches an update.","security":[{"token":[]}],"tags":["Updates"],"operationId":"PatchCodePushUpdate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Disable update","content":{"application/json":{"examples":{"201 - Full update":{"value":{"app_version":"1.3.0","created_at":"2025-02-06T09:26:01.000Z","created_by":{"id":"default-user-slug","email":"Deleted user account","username":"N/A","avatar_url":null},"deployment_id":"123e4567-e89b-12d3-a456-426614174000","description":"Textual summary of the update.","disabled":false,"file_name":"main.jsbundle","file_size_bytes":123456,"hash":"94b7659b8c6452b3734915a7ae01c7d24d3571fc9e2d0be3acd1b0a1b81bc6e8","id":"9a35afac-81a4-488d-a986-3c13015d70a0","label":"9a35afac-81a4-488d-a986-3c13015d70a0","mandatory":true,"rollout":100,"update_version":"v13","updated_at":"2025-02-06T09:26:01.000Z","updated_by":{"id":"default-user-slug","email":"Deleted user account","username":"N/A","avatar_url":null},"signed":false}},"201 - Disable update":{"value":{"app_version":"1.3.0","created_at":"2025-02-06T09:26:01.000Z","created_by":{"id":"default-user-slug","email":"Deleted user account","username":"N/A","avatar_url":null},"deployment_id":"123e4567-e89b-12d3-a456-426614174000","description":"Textual summary of the update.","disabled":true,"file_name":"main.jsbundle","file_size_bytes":123456,"hash":"94b7659b8c6452b3734915a7ae01c7d24d3571fc9e2d0be3acd1b0a1b81bc6e8","id":"9a35afac-81a4-488d-a986-3c13015d70a0","label":"9a35afac-81a4-488d-a986-3c13015d70a0","mandatory":false,"rollout":10,"update_version":"v13","updated_at":"2025-02-06T09:26:01.000Z","updated_by":{"id":"default-user-slug","email":"Deleted user account","username":"N/A","avatar_url":null},"signed":false}}}}}},"400":{"description":"Bad request - The provided update id is invalid","content":{"application/json":{"examples":{"400 - Bad request - The provided update id is invalid":{"value":{"code":"ERR_INVALID_UUID","message":"The given update id is not a uuid: invalid."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"disabled":{"type":"string","description":"If set to true, users won't be able to download the update."},"mandatory":{"type":"string","description":"If set to true, marks the update as mandatory for all users."},"rollout":{"type":"number","description":"The percentage (0–100) of users to gradually roll the update out to."}}}}}}}},"/updates/{id}/status":{"get":{"summary":"Gets the status of an update","description":"Gets the status of an update.","security":[{"token":[]}],"tags":["Updates"],"operationId":"GetCodePushUpdateStatus","parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the update.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get the update status","content":{"application/json":{"examples":{"200 - Get the update status":{"value":{"update_id":"9a35afac-81a4-488d-a986-3c13015d70a0","status":"uploaded","status_reason":""}}}}}},"400":{"description":"Bad request","content":{"application/json":{"examples":{"400 - Bad request":{"value":{"code":"ERR_INVALID_UUID","message":"The given update id is not a uuid: invalid."}}}}}},"404":{"description":"Update not found","content":{"application/json":{"examples":{"404 - Update not found":{"value":{"code":"ERR_NOT_FOUND","message":"cannot find update for the provided uuid"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}}},"/updates/{id}/upload-url":{"get":{"summary":"Generates an upload url for an update.","description":"Generates a signed upload url valid for 1 hour for an update to be uploaded to Bitrise.","security":[{"token":[]}],"tags":["Updates"],"operationId":"GetCodePushUpdateUploadUrl","parameters":[{"name":"deployment_id","in":"query","required":true,"description":"The uuidV4 identifier of the deployment under which the update will be uploaded.","schema":{"type":"string"}},{"name":"id","in":"path","description":"A uuidV4 identifier for the update.","required":true,"schema":{"type":"string"}},{"name":"app_version","in":"query","required":true,"description":"The app version (e.g., 1.0.0) that this update targets.","schema":{"type":"string"}},{"name":"description","in":"query","required":false,"description":"A description of the update to display in the release history.","schema":{"type":"string"}},{"name":"disabled","in":"query","required":false,"description":"If set to true, disables the update immediately after upload.","schema":{"type":"string"}},{"name":"file_name","in":"query","required":true,"description":"The name of the uploaded file (e.g., main.jsbundle).","schema":{"type":"string"}},{"name":"file_size_bytes","in":"query","required":true,"description":"The size of the file in bytes, used to validate the upload.","schema":{"type":"string"}},{"name":"mandatory","in":"query","required":false,"description":"If set to true, marks the update as mandatory for all users.","schema":{"type":"string"}},{"name":"rollout","in":"query","required":false,"description":"The percentage (0–100) of users to gradually roll the update out to.","schema":{"type":"string"}}],"responses":{"200":{"description":"Get upload url","content":{"application/json":{"examples":{"200 - Get upload url":{"value":{"headers":{"Content-Type":"application/vnd.android.package-archive"},"method":"PUT","url":"https://bitrise-storage.com/apps/io.bitrise.test{deployments123e4567-e89b-12d3-a456-426614174000/updates/9a35afac-81a4-488d-a986-3c13015d70a0/New file?signed-url-data"}}}}}},"400":{"description":"Bad request - The app version is missing","content":{"application/json":{"examples":{"400 - when app_version parameter is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: app_version"}},"400 - when file_name parameter is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: file_name"}},"400 - when file_size_bytes parameter is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: file_size_bytes"}},"400 - Bad request - The provided update id is invalid":{"value":{"code":"ERR_INVALID_UUID","message":"the provided uuid is invalid"}},"400 - Bad request - The app version is missing":{"value":{"code":"ERR_VALIDATION","message":"app_version is required"}}}}}},"404":{"description":"Not found - The deployment is not found","content":{"application/json":{"examples":{"404 - Not found - The deployment is not found":{"value":{"code":"ERR_NOT_FOUND","message":"cannot find deployment for the provided uuid"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}}},"/updates/{update_id}/staged-rollout-schedule":{"delete":{"summary":"Delete staged rollout schedule","description":"Deletes the staged rollout schedule for the given CodePush update.","security":[{"token":[]}],"tags":["Updates"],"operationId":"DeleteCodePushStagedRolloutSchedule","parameters":[{"name":"update_id","in":"path","description":"The uuidV4 identifier of the update.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Delete staged rollout schedule","content":{"application/json":{"examples":{"204 - Delete staged rollout schedule":{"value":{}}}}}},"412":{"description":"Schedule already finished","content":{"application/json":{"examples":{"412 - No schedule exists for this update":{"value":{"code":"ERR_NOT_SCHEDULED","message":"No schedule exists for this update."}},"412 - Schedule already finished":{"value":{"code":"ERR_SCHEDULE_ALREADY_FINISHED","message":"Cannot delete: already finished."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"get":{"summary":"Get staged rollout schedule","description":"Gets the staged rollout schedule for the given CodePush update.","security":[{"token":[]}],"tags":["Updates"],"operationId":"GetCodePushStagedRolloutSchedule","parameters":[{"name":"update_id","in":"path","description":"The uuidV4 identifier of the update.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get staged rollout schedule","content":{"application/json":{"examples":{"200 - Get staged rollout schedule":{"value":{"schedule":[{"id":"ab1de5df-7b10-49a6-91e6-46b08395ce71","has_run":false,"rollout_percentage":50.0,"when":"2025-02-12T09:26:01.000Z","last_run_at":null,"status":null}],"setup_location":"UTC","paused":false,"last_paused_at":null,"failure_reason":null}}}}}},"404":{"description":"No schedule found for this update","content":{"application/json":{"examples":{"404 - No schedule found for this update":{"value":{"code":"ERR_NOT_FOUND","message":"No staged rollout schedule found for this update."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"post":{"summary":"Create staged rollout schedule","description":"Creates a staged rollout schedule for the given CodePush update.","security":[{"token":[]}],"tags":["Updates"],"operationId":"CreateCodePushStagedRolloutSchedule","parameters":[{"name":"update_id","in":"path","description":"The uuidV4 identifier of the update.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Create staged rollout schedule","content":{"application/json":{"examples":{"201 - Create staged rollout schedule":{"value":{}}}}}},"400":{"description":"First step does not exceed current rollout percentage","content":{"application/json":{"examples":{"400 - Invalid time format":{"value":{"code":"ERR_INVALID_TIME_FORMAT","message":"when must be a valid datetime string; given value: 'gibberish'"}},"400 - First step does not exceed current rollout percentage":{"value":{"code":"ERR_INVALID_PARAMETER","message":"first schedule step (50.0%) must exceed the update's current rollout percentage (100.0%)"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"location":{"type":"string","description":"The time zone in which the schedule dates are provided. It can be any TZ database time zone or UTC if the dates are given in Coordinated Universal Time."},"schedule":{"type":"array","items":{"type":"object","properties":{"percentage":{"type":"number","description":"A number greater than 0 and less than or equal to 100 representing the release percentage, where 100 indicates a full release."},"when":{"type":"string","description":"A date in ISO 8601 string format specifying when to run the schedule."}},"required":["percentage","when"]}}},"required":["location","schedule"]}}}}}},"/updates/{update_id}/staged-rollout-schedule/pause":{"post":{"summary":"Pause staged rollout schedule","description":"Pauses the staged rollout schedule for the given CodePush update.","security":[{"token":[]}],"tags":["Updates"],"operationId":"PauseCodePushStagedRolloutSchedule","parameters":[{"name":"update_id","in":"path","description":"The uuidV4 identifier of the update.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Pause staged rollout schedule","content":{"application/json":{"examples":{"204 - Pause staged rollout schedule":{"value":{}}}}}},"412":{"description":"Schedule already finished","content":{"application/json":{"examples":{"412 - No schedule exists for this update":{"value":{"code":"ERR_NOT_SCHEDULED","message":"No schedule exists for this update."}},"412 - Schedule already finished":{"value":{"code":"ERR_SCHEDULE_ALREADY_FINISHED","message":"Cannot pause: already finished."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}}},"/updates/{update_id}/staged-rollout-schedule/resume":{"post":{"summary":"Resume staged rollout schedule","description":"Resumes a paused staged rollout schedule for the given CodePush update.","security":[{"token":[]}],"tags":["Updates"],"operationId":"ResumeCodePushStagedRolloutSchedule","parameters":[{"name":"update_id","in":"path","description":"The uuidV4 identifier of the update.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Resume staged rollout schedule","content":{"application/json":{"examples":{"204 - Resume staged rollout schedule":{"value":{}}}}}},"400":{"description":"First step does not exceed current rollout percentage","content":{"application/json":{"examples":{"400 - Invalid time format":{"value":{"code":"ERR_INVALID_TIME_FORMAT","message":"when must be a valid datetime string; given value: 'gibberish'"}},"400 - First step does not exceed current rollout percentage":{"value":{"code":"ERR_INVALID_PARAMETER","message":"first schedule step (50.0%) must exceed the update's current rollout percentage (100.0%)"}}}}}},"412":{"description":"Schedule already finished","content":{"application/json":{"examples":{"412 - Schedule not paused":{"value":{"code":"ERR_SCHEDULE_NOT_PAUSED","message":"Cannot resume: schedule is not paused."}},"412 - No schedule exists for this update":{"value":{"code":"ERR_NOT_SCHEDULED","message":"No schedule exists for this update."}},"412 - Schedule already finished":{"value":{"code":"ERR_SCHEDULE_ALREADY_FINISHED","message":"Cannot resume: already finished."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"location":{"type":"string","description":"The time zone in which the schedule dates are provided. It can be any TZ database time zone or UTC if the dates are given in Coordinated Universal Time."},"schedule":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the existing schedule item, returned by the corresponding GET endpoint."},"percentage":{"type":"number","description":"A number greater than 0 and less than or equal to 100 representing the release percentage, where 100 indicates a full release."},"when":{"type":"string","description":"A date in ISO 8601 string format specifying when to run the schedule."}},"required":["id","percentage","when"]}}},"required":["location","schedule"]}}}}}}},"servers":[{"url":"{baseURL}/release-management/v2/code-push/v1","variables":{"baseURL":{"default":"https://api.bitrise.io","description":"The server base URL with the scheme."}}}],"components":{"securitySchemes":{"token":{"type":"apiKey","in":"header","description":"PAT necessary to use API calls","name":"authorization"}}},"tags":[{"name":"Deployments","description":"Available in the Basic plan."},{"name":"Updates","description":"Available in the Basic plan."},{"name":"Metrics","description":"Available in the Basic plan."}]} \ No newline at end of file diff --git a/api/bitrise-rm-store-releases.json b/api/bitrise-rm-store-releases.json new file mode 100644 index 00000000..466b7584 --- /dev/null +++ b/api/bitrise-rm-store-releases.json @@ -0,0 +1 @@ +{"openapi":"3.0.1","info":{"title":"Release Management API - App Versions","version":"v2.1","description":"**Looking for the old API?** You can find it here: V1 API spec\n\nThe old API will be deprecated on February 1st 2027. Make sure that you have migrated to the new API before then.\n\nView the V1 → V2 Migration Guide"},"externalDocs":{"description":"API Changelog (json format)","url":"https://storage.googleapis.com/bitrise-release-management-public-api-docs/changelog_v2_store_releases.json"},"paths":{"/app-versions":{"get":{"summary":"Gets a list of app versions","description":"Gives back a list of app versions.","operationId":"ListReleases","security":[{"token":[]}],"tags":["App Versions"],"parameters":[{"name":"app_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"items_per_page","in":"query","required":false,"schema":{"default":10,"maximum":50,"minimum":1,"type":"integer"},"description":"Specifies the maximum number of app versions returned per request"},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer"},"description":"Specifies which page should be returned from the whole result set in a paginated scenario"}],"responses":{"200":{"description":"App versions","content":{"application/json":{"examples":{"200 - App versions":{"value":{"count":2,"items":[{"app_store_release_type":"MANUAL","artifact_source":"ci","automatic_store_upload":false,"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","created_at":"2025-02-11T09:26:01.000Z","default_release_method":null,"demo":false,"description":"Another awesome release","id":"fbaf4e63-638f-4f40-a00b-9ec1ef3d231a","name":"1.3.1","release_branch":"main","release_candidate_build_slug":null,"release_candidate_id":null,"release_candidate_locked":false,"released_at":null,"slack_notification_integration_id":null,"slack_webhook_url":null,"status":"in-progress","teams_webhook_url":null,"workflow":null,"stages":[],"timeline":[],"platform":"android","store_app_id":"io.bitrise.test","store_app_name":"Test Android App","automations":[],"outgoing_webhooks":[]},{"app_store_release_type":"MANUAL","artifact_source":"ci","automatic_store_upload":false,"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","created_at":"2025-02-11T09:26:01.000Z","default_release_method":null,"demo":false,"description":"Awesome release","id":"a6347d7b-f8e1-4b48-bd39-18b5c60da288","name":"1.2.1","release_branch":"main","release_candidate_build_slug":null,"release_candidate_id":null,"release_candidate_locked":false,"released_at":null,"slack_notification_integration_id":null,"slack_webhook_url":null,"status":"completed","teams_webhook_url":null,"workflow":null,"stages":[],"timeline":[],"platform":"android","store_app_id":"io.bitrise.test","store_app_name":"Test Android App","automations":[],"outgoing_webhooks":[]}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"post":{"summary":"Creates an app version","description":"Creates an app version under the given app.","operationId":"CreateRelease","security":[{"token":[]}],"tags":["App Versions"],"parameters":[],"responses":{"201":{"description":"The created app version","content":{"application/json":{"examples":{"201 - Using the deprecated use_presets property":{"value":{"app_store_release_type":"MANUAL","artifact_source":"ci","automatic_store_upload":true,"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","created_at":"2025-02-11T09:26:01.000Z","default_release_method":"phased","demo":false,"description":null,"id":"921db057-73eb-418a-b7ed-04f451e9dd85","name":"Awesome release","release_branch":"main","release_candidate_build_slug":null,"release_candidate_id":null,"release_candidate_locked":false,"released_at":null,"slack_notification_integration_id":"ceec9565-0de0-4603-92b2-255e42c2d203","slack_webhook_url":"https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX","status":"in-progress","teams_webhook_url":"https://outlook.office.com/webhookb2/valid","workflow":"build-new-app-version","stages":[{"id":1,"name":"release-candidate","status":"in-progress","target_date":"2025-02-13T09:26:01.000Z","started_at":"2025-02-11T09:26:01.000Z","completed_at":null,"disabled":false,"view_only":false},{"id":2,"name":"google-play-upload","status":"pending","target_date":"2025-02-16T09:26:01.000Z","started_at":null,"completed_at":null,"disabled":true,"view_only":false},{"id":3,"name":"approvals","status":"pending","target_date":"2025-02-19T09:26:01.000Z","started_at":null,"completed_at":null,"disabled":false,"view_only":false,"tasks":[{"description":"After quality assurance has finished testing, check back here.","due_date":null,"completed":false,"completed_at":null,"created_at":"2025-02-11T09:26:01.000Z","id":1,"summary":"qa-check","assigned_user":null,"creator_user":null},{"description":"Everything is adhering to our security policies.","due_date":null,"completed":false,"completed_at":null,"created_at":"2025-02-11T09:26:01.000Z","id":2,"summary":"security-check","assigned_user":null,"creator_user":null}]},{"id":4,"name":"release","status":"pending","target_date":"2025-02-20T09:26:01.000Z","started_at":null,"completed_at":null,"disabled":true,"view_only":false}],"timeline":[{"stage":"release-candidate","target_date":"2025-02-13T09:26:01.000Z"},{"stage":"google-play-upload","target_date":"2025-02-16T09:26:01.000Z"},{"stage":"approvals","target_date":"2025-02-19T09:26:01.000Z"},{"stage":"release","target_date":"2025-02-20T09:26:01.000Z"}],"platform":"android","store_app_id":"io.bitrise.test","store_app_name":"Test Android App","automations":[{"id":63,"created_at":"2025-02-11T09:26:01.000Z","event_name":"release_candidate_set","workflow_name":"google-ser-cred-test","pipeline_name":null},{"id":64,"created_at":"2025-02-11T09:26:01.000Z","event_name":"approvals_completed","workflow_name":null,"pipeline_name":"notify-stakeholders"}],"outgoing_webhooks":[{"id":"9e1817c7-ccca-4e0d-9155-0071cb07f966","created_at":"2025-02-11T09:26:01.000Z","events":null,"all_events":true,"webhook_configuration_id":"5623239f-28ea-4b8d-856e-8cb50073fade"},{"id":"a4410940-1f5e-45ec-9ce0-b47db15b210e","created_at":"2025-02-11T09:26:01.000Z","events":["release_created","release_candidate_set"],"all_events":false,"webhook_configuration_id":"8352be85-758c-46bb-9890-03b4a8d70950"}]}},"201 - Locking the release candidate":{"value":{"app_store_release_type":"MANUAL","artifact_source":null,"automatic_store_upload":false,"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","created_at":"2025-02-11T09:26:01.000Z","default_release_method":null,"demo":false,"description":null,"id":"921db057-73eb-418a-b7ed-04f451e9dd85","name":"Locked release","release_branch":null,"release_candidate_build_slug":null,"release_candidate_id":null,"release_candidate_locked":true,"released_at":null,"slack_notification_integration_id":null,"slack_webhook_url":null,"status":"scheduled","teams_webhook_url":null,"workflow":null,"stages":[{"id":185,"name":"release-candidate","status":"pending","target_date":null,"started_at":null,"completed_at":null,"disabled":false,"view_only":false},{"id":186,"name":"google-play-upload","status":"pending","target_date":null,"started_at":null,"completed_at":null,"disabled":true,"view_only":false},{"id":187,"name":"approvals","status":"pending","target_date":null,"started_at":null,"completed_at":null,"disabled":false,"view_only":false,"tasks":[]},{"id":188,"name":"release","status":"pending","target_date":null,"started_at":null,"completed_at":null,"disabled":true,"view_only":false}],"timeline":[{"stage":"release-candidate","target_date":null},{"stage":"google-play-upload","target_date":null},{"stage":"approvals","target_date":null},{"stage":"release","target_date":null}],"platform":"android","store_app_id":"io.bitrise.test","store_app_name":"Test Android App","automations":[],"outgoing_webhooks":[]}},"201 - The created app version":{"value":{"app_store_release_type":"MANUAL","artifact_source":"ci","automatic_store_upload":true,"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","created_at":"2025-02-11T09:26:01.000Z","default_release_method":"phased","demo":false,"description":null,"id":"921db057-73eb-418a-b7ed-04f451e9dd85","name":"Awesome release","release_branch":"main","release_candidate_build_slug":null,"release_candidate_id":null,"release_candidate_locked":false,"released_at":null,"slack_notification_integration_id":"ceec9565-0de0-4603-92b2-255e42c2d203","slack_webhook_url":"https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX","status":"in-progress","teams_webhook_url":"https://outlook.office.com/webhookb2/valid","workflow":"build-new-app-version","stages":[{"id":1,"name":"release-candidate","status":"in-progress","target_date":"2025-02-13T09:26:01.000Z","started_at":"2025-02-11T09:26:01.000Z","completed_at":null,"disabled":false,"view_only":false},{"id":2,"name":"google-play-upload","status":"pending","target_date":"2025-02-16T09:26:01.000Z","started_at":null,"completed_at":null,"disabled":true,"view_only":false},{"id":3,"name":"approvals","status":"pending","target_date":"2025-02-19T09:26:01.000Z","started_at":null,"completed_at":null,"disabled":false,"view_only":false,"tasks":[{"description":"After quality assurance has finished testing, check back here.","due_date":null,"completed":false,"completed_at":null,"created_at":"2025-02-11T09:26:01.000Z","id":1,"summary":"qa-check","assigned_user":null,"creator_user":null},{"description":"Everything is adhering to our security policies.","due_date":null,"completed":false,"completed_at":null,"created_at":"2025-02-11T09:26:01.000Z","id":2,"summary":"security-check","assigned_user":null,"creator_user":null}]},{"id":4,"name":"release","status":"pending","target_date":"2025-02-20T09:26:01.000Z","started_at":null,"completed_at":null,"disabled":true,"view_only":false}],"timeline":[{"stage":"release-candidate","target_date":"2025-02-13T09:26:01.000Z"},{"stage":"google-play-upload","target_date":"2025-02-16T09:26:01.000Z"},{"stage":"approvals","target_date":"2025-02-19T09:26:01.000Z"},{"stage":"release","target_date":"2025-02-20T09:26:01.000Z"}],"platform":"android","store_app_id":"io.bitrise.test","store_app_name":"Test Android App","automations":[{"id":65,"created_at":"2025-02-11T09:26:01.000Z","event_name":"release_candidate_set","workflow_name":"google-ser-cred-test","pipeline_name":null},{"id":66,"created_at":"2025-02-11T09:26:01.000Z","event_name":"approvals_completed","workflow_name":null,"pipeline_name":"notify-stakeholders"}],"outgoing_webhooks":[{"id":"9e1817c7-ccca-4e0d-9155-0071cb07f966","created_at":"2025-02-11T09:26:01.000Z","events":null,"all_events":true,"webhook_configuration_id":"5623239f-28ea-4b8d-856e-8cb50073fade"},{"id":"a4410940-1f5e-45ec-9ce0-b47db15b210e","created_at":"2025-02-11T09:26:01.000Z","events":["release_created","release_candidate_set"],"all_events":false,"webhook_configuration_id":"8352be85-758c-46bb-9890-03b4a8d70950"}]}}}}}},"400":{"description":"Validation error","content":{"application/json":{"examples":{"400 - Parameter missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: name"}},"400 - Validation error":{"value":{"code":"ERR_VALIDATION","message":"This slack integration ID is not valid."}}}}}},"422":{"description":"Unprocessable entity error for outgoing webhooks","content":{"application/json":{"examples":{"422 - Unprocessable entity error for outgoing webhooks":{"value":{"code":"ERR_UNPROCESSABLE_ENTITY","message":"The outgoing webhook with webhook_configuration_id '5623239f-28ea-4b8d-856e-8cb50073fade' cannot have all_events set to true while specifying events."}}}}}},"409":{"description":"Conflict","content":{"application/json":{"examples":{"409 - Conflict":{"value":{"code":"ERR_RESOURCE_ALREADY_EXISTS","message":"App Version with name \"Awesome release\" already exists."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"artifact_source":{"type":"string","description":"The source of the artifact. Can be 'ci' or 'api'."},"app_id":{"type":"string","description":"The app id for the app version. An UUIDv4 identifier."},"name":{"type":"string","description":"The name of your app version. In case of iOS platform this will be used in the App Store Connect for the app version and only allows X.Y.Z format"},"description":{"type":"string","description":"The description for your app version."},"release_branch":{"type":"string","description":"The release branch part of the build configuration for the Release candidate stage."},"workflow":{"type":"string","description":"The workflow part of the build configuration for the Release candidate stage."},"slack_webhook_url":{"type":"string","deprecated":true,"description":"You can get notifications about release updates on Slack by setting this value. Make sure to send the properly formatted webhook url. Regex for validation: ^https:\\/\\/.*\\.slack\\.com\\/services\\/T[a-zA-Z0-9]*\\/B[a-zA-Z0-9]*\\/[a-zA-Z0-9]*$"},"slack_notification_integration_id":{"type":"string","description":"You can get notifications about release updates on Slack by setting this value. Make sure to send the integration ID found in Workspace Settings."},"teams_webhook_url":{"type":"string","description":"You can get notifications about release updates on Teams by setting this value. Make sure to send the properly formatted webhook url. Regex for validation: ^https:\\/\\/(?:.*\\.webhook|outlook)\\.office(?:365)?\\.com\\/webhookb2\\/.*"},"automatic_store_upload":{"type":"boolean","description":"If set to true, Release Management will upload all successful builds that ran on the given branch with the given workflow to the App Store."},"release_candidate_locked":{"type":"boolean","description":"Set to true to lock the release candidate and prevent automatic selection of the latest artifact. When false or omitted, the latest matching artifact is selected automatically."},"approvals":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"due_date":{"type":"string"},"summary":{"type":"string"}}},"description":"Tasks for the approval stage."},"automation":{"type":"array","items":{"type":"object","properties":{"event_name":{"enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed"],"type":"string"},"workflow_name":{"type":"string"},"pipeline_name":{"type":"string"}}},"description":"Automation events (workflow or pipeline runs) setup for specific event types."},"outgoing_webhooks":{"type":"array","items":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed","app_store_release_cancelled","app_store_release_completed","app_store_release_started","app_store_review_approved","app_store_review_cancelled","app_store_review_rejected","app_store_review_submitted","app_store_version_created","app_store_version_updated","app_version_added","approval_task_added","approval_task_changed","approval_task_completed","approval_task_deleted","approval_task_reopened","approval_tasks_completed","auto-upload_disabled","auto-upload_enabled","automation_added","automation_removed","google_play_automated_rollout_cancelled","google_play_automated_rollout_configured","google_play_automated_rollout_paused","google_play_automated_rollout_resumed","google_play_release_completed","google_play_release_notes_localization_added","google_play_release_notes_localization_changed","google_play_release_notes_localization_removed","google_play_release_started","google_play_rollout_percentage_changed","google_play_testing_track_release_completed","google_play_testing_track_release_failed","google_play_upload_completed","google_play_upload_failed","google_play_upload_started","metadata_localization_added","metadata_localization_changed","metadata_localization_removed","microsoft_teams_connection_changed","outgoing_webhook_added","outgoing_webhook_deleted","outgoing_webhook_updated","phased_release_disabled","phased_release_enabled","phased_release_paused","phased_release_resumed","release_candidate_auto_select_latest_build_disabled","release_candidate_auto_select_latest_build_enabled","release_candidate_build_selected","release_candidate_source_changed","release_description_changed","release_settings_changed","slack_connection_changed","stopped_managing_release","testflight_app_review_approved","testflight_app_review_rejected","testflight_app_review_submitted","testflight_distribution_start_failed","testflight_distribution_started","testflight_distribution_stopped","testflight_processing_completed","testflight_processing_failed","testflight_upload_completed","testflight_upload_failed","testflight_upload_started","testflight_what_to_test_added","testflight_what_to_test_changed","testflight_what_to_test_deleted"]},"description":"A list of event names that will trigger this webhook. These events correspond to specific actions or states in the release process."},"all_events":{"type":"boolean","description":"Indicates whether this webhook should be triggered for all events. Set to true to enable the webhook for every event."},"webhook_configuration_id":{"type":"string","description":"The unique identifier of the webhook configuration, that can be found in the workspace integration settings. This ID links the webhook configuration to the workspace."}}},"description":"COMING SOON. A collection of outgoing webhooks configured to trigger for specific event types. Each webhook can be associated with one or more events or set to trigger for all events."},"timeline":{"type":"array","items":{"type":"object","properties":{"stage":{"enum":["release-candidate","approvals","testflight-upload","google-play-upload","app-store-review","release"],"type":"string"},"target_date":{"type":"string","description":"A valid date."}}},"description":"Timeline settings for the app version. Dates set here will appear in the sidebar. These deadlines serve purely informational purposes, no automatic action will take place at the scheduled times."},"use_presets":{"type":"boolean","deprecated":true,"description":"(DEPRECATED use presets_id instead) If set the release will be filled with data from previously set presets. Presets can contain release branch and workflow, automatic store upload, notification urls, approvals and automation lists. In case any of these values are set both in presets and in the release request the variables set in the request will take precedence."},"presets_id":{"type":"string","description":"The presets id to be used for the release. Presets can contain release branch and workflow, automatic store upload, notification URLs, approvals, and automation lists. In case any of these values are set both in presets and in the release request, the variables set in the request will take precedence. The presets id can be retrieved using the presets listing endpoint."}},"required":["name","app_id"]}}}}}},"/app-versions/{id}":{"delete":{"summary":"Deletes an app version","description":"Deletes an app version.","operationId":"DeleteRelease","security":[{"token":[]}],"tags":["App Versions"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The deleted app version","content":{"application/json":{"examples":{"200 - The deleted app version":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"get":{"summary":"Gets an app version","description":"Gives back an app version.","operationId":"GetRelease","security":[{"token":[]}],"tags":["App Versions"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"App version","content":{"application/json":{"examples":{"200 - App version":{"value":{"app_store_release_type":"MANUAL","artifact_source":"ci","automatic_store_upload":false,"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","created_at":"2025-02-11T09:26:01.000Z","default_release_method":null,"demo":false,"description":"Awesome release","id":"fb55ea1e-0c96-46f2-af47-7dde1f26395a","name":"1.2.1","release_branch":"main","release_candidate_build_slug":"rc-build-slug","release_candidate_id":null,"release_candidate_locked":true,"released_at":"2025-02-10T10:26:01.000Z","slack_notification_integration_id":"ceec9565-0de0-4603-92b2-255e42c2d203","slack_webhook_url":null,"status":"completed","teams_webhook_url":"https://xxxxx.webhook.office.com/xxxxxxxxx","workflow":"build_app","stages":[{"id":1,"name":"release-candidate","status":"completed","target_date":"2025-01-28T09:26:01.000Z","started_at":"2025-01-21T09:26:01.000Z","completed_at":"2025-01-28T09:26:01.000Z","disabled":false,"view_only":true},{"id":2,"name":"google-play-upload","status":"completed","target_date":"2025-01-29T09:26:01.000Z","started_at":"2025-01-28T09:26:01.000Z","completed_at":"2025-01-29T09:26:01.000Z","disabled":false,"view_only":true},{"id":3,"name":"approvals","status":"completed","target_date":"2025-02-04T09:26:01.000Z","started_at":"2025-01-31T09:26:01.000Z","completed_at":"2025-02-03T09:26:01.000Z","disabled":false,"view_only":true,"tasks":[{"description":"Do this task first","due_date":"2025-02-07T09:26:01.000Z","completed":true,"completed_at":"2025-02-08T09:26:01.000Z","created_at":"2025-01-30T09:26:01.000Z","id":1,"summary":"This is a very important task","assigned_user":null,"creator_user":null},{"description":"Do this task last","due_date":"2025-02-07T09:26:01.000Z","completed":true,"completed_at":"2025-02-09T09:26:01.000Z","created_at":"2025-01-30T09:26:01.000Z","id":2,"summary":"This is another very important task","assigned_user":null,"creator_user":null}]},{"id":4,"name":"release","status":"completed","target_date":"2025-02-09T09:26:01.000Z","started_at":"2025-02-07T09:26:01.000Z","completed_at":"2025-02-10T10:26:01.000Z","disabled":false,"view_only":true}],"timeline":[{"stage":"release-candidate","target_date":"2025-01-28T09:26:01.000Z"},{"stage":"google-play-upload","target_date":"2025-01-29T09:26:01.000Z"},{"stage":"approvals","target_date":"2025-02-04T09:26:01.000Z"},{"stage":"release","target_date":"2025-02-09T09:26:01.000Z"}],"platform":"android","store_app_id":"io.bitrise.test","store_app_name":"Test Android App","automations":[{"id":1,"created_at":"2024-05-09T15:52:21.000Z","event_name":"release_candidate_set","workflow_name":"test-deploy","pipeline_name":null},{"id":2,"created_at":"2024-05-09T15:52:21.000Z","event_name":"release_started","workflow_name":null,"pipeline_name":"inform-stakeholders"}],"outgoing_webhooks":[{"id":"a4410940-1f5e-45ec-9ce0-b47db15b210e","created_at":"2024-05-09T15:52:21.000Z","events":["release_candidate_set"],"all_events":true,"webhook_configuration_id":"c793aad3-9e6a-44b3-af7a-187d97de9f55"},{"id":"9e1817c7-ccca-4e0d-9155-0071cb07f966","created_at":"2024-05-09T15:52:21.000Z","events":["release_created","release_candidate_set"],"all_events":false,"webhook_configuration_id":"2b3c7e23-c974-4c78-84f0-200710c8430e"}]}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"patch":{"summary":"Updates an app version","description":"Updates an app version.","operationId":"UpdateRelease","security":[{"token":[]}],"tags":["App Versions"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The updated app version","content":{"application/json":{"examples":{"200 - The updated app version":{"value":{"app_store_release_type":"MANUAL","artifact_source":"ci","automatic_store_upload":true,"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","created_at":"2025-02-11T09:26:01.000Z","default_release_method":null,"demo":false,"description":"New awesome release","id":"bdf9620b-a5c3-47fe-8c4a-c412d4af7317","name":"1.2.1","release_branch":"main","release_candidate_build_slug":null,"release_candidate_id":null,"release_candidate_locked":false,"released_at":null,"slack_notification_integration_id":"ceec9565-0de0-4603-92b2-255e42c2d203","slack_webhook_url":null,"status":"scheduled","teams_webhook_url":"https://outlook.office.com/webhookb2/valid","workflow":"build-app","stages":[{"id":1,"name":"release-candidate","status":"completed","target_date":"2025-02-13T09:26:01.000Z","started_at":"2025-01-21T09:26:01.000Z","completed_at":"2025-01-28T09:26:01.000Z","disabled":false,"view_only":true},{"id":2,"name":"google-play-upload","status":"completed","target_date":"2025-02-16T09:26:01.000Z","started_at":"2025-01-28T09:26:01.000Z","completed_at":"2025-01-29T09:26:01.000Z","disabled":false,"view_only":true},{"id":3,"name":"approvals","status":"completed","target_date":"2025-02-19T09:26:01.000Z","started_at":"2025-01-31T09:26:01.000Z","completed_at":"2025-02-03T09:26:01.000Z","disabled":false,"view_only":true,"tasks":[{"description":"After quality assurance has finished testing, check back here.","due_date":"2075-02-11T09:26:01.000Z","completed":false,"completed_at":null,"created_at":"2025-02-11T09:26:01.000Z","id":1,"summary":"qa-check","assigned_user":null,"creator_user":{"avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png","email":"default-user@example.com","username":"default-user","slug":"default-user-slug"}},{"description":"Everything is adhering to our security policies.","due_date":"2075-02-11T09:26:01.000Z","completed":false,"completed_at":null,"created_at":"2025-02-11T09:26:01.000Z","id":2,"summary":"security-check","assigned_user":null,"creator_user":{"avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png","email":"default-user@example.com","username":"default-user","slug":"default-user-slug"}}]},{"id":4,"name":"release","status":"completed","target_date":"2025-02-20T09:26:01.000Z","started_at":"2025-02-07T09:26:01.000Z","completed_at":"2025-02-10T10:26:01.000Z","disabled":false,"view_only":true}],"timeline":[{"stage":"release-candidate","target_date":"2025-02-13T09:26:01.000Z"},{"stage":"google-play-upload","target_date":"2025-02-16T09:26:01.000Z"},{"stage":"approvals","target_date":"2025-02-19T09:26:01.000Z"},{"stage":"release","target_date":"2025-02-20T09:26:01.000Z"}],"platform":"android","store_app_id":"io.bitrise.test","store_app_name":"Test Android App","automations":[{"id":1,"created_at":"2025-02-11T09:26:01.000Z","event_name":"release_candidate_set","workflow_name":"google-ser-cred-test","pipeline_name":null},{"id":2,"created_at":"2025-02-11T09:26:01.000Z","event_name":"approvals_completed","workflow_name":null,"pipeline_name":"notify-stakeholders"}],"outgoing_webhooks":[{"id":"9e1817c7-ccca-4e0d-9155-0071cb07f966","created_at":"2025-02-11T09:26:01.000Z","events":null,"all_events":true,"webhook_configuration_id":"5623239f-28ea-4b8d-856e-8cb50073fade"},{"id":"a4410940-1f5e-45ec-9ce0-b47db15b210e","created_at":"2025-02-11T09:26:01.000Z","events":["approvals_completed","release_candidate_set"],"all_events":false,"webhook_configuration_id":"8352be85-758c-46bb-9890-03b4a8d70950"}]}}}}}},"400":{"description":"Validation error for outgoing webhooks","content":{"application/json":{"examples":{"400 - Bad request":{"value":{"code":"ERR_VALIDATION","message":"This slack integration ID is not valid."}},"400 - Validation error for outgoing webhooks":{"value":{"code":"ERR_UNPROCESSABLE_ENTITY","message":"The outgoing webhook with webhook_configuration_id '5623239f-28ea-4b8d-856e-8cb50073fade' cannot have all_events set to true while specifying events."}}}}}},"409":{"description":"App version is scheduled or in progress","content":{"application/json":{"examples":{"409 - App version already completed":{"value":{"code":"ERR_CONFLICT","message":"Release is in final status and cannot be modified."}},"409 - App Store review is in progress":{"value":{"code":"ERR_CONFLICT","message":"App Store review is scheduled or is in progress so release candidate cannot be changed."}},"409 - App version is scheduled or in progress":{"value":{"code":"ERR_CONFLICT","message":"Release is scheduled or is in progress so release candidate cannot be changed."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"artifact_source":{"type":"string","description":"Determines if artifacts are coming from the Bitrise CI or from external source via API upload. Valid values are \"api\" or \"ci\". If release_branch or workflow is configured it should be \"ci\"."},"description":{"type":"string"},"release_branch":{"type":"string","description":"The release branch part of the build configuration for the Release candidate stage."},"release_candidate_id":{"type":"string","description":"The uuidV4 identifier of the artifact."},"release_candidate_locked":{"type":"string","description":"Set to true to lock the currently selected release candidate and prevent automatic selection of the latest artifact."},"workflow":{"type":"string","description":"The workflow part of the build configuration for the Release candidate stage."},"automatic_store_upload":{"type":"boolean","description":"If set to true, Release Management will upload all successful builds that ran on the given branch with the given workflow to the App Store."},"slack_webhook_url":{"type":"string","deprecated":true,"description":"You can get notifications about release updates on Slack by setting this value. Make sure to send the properly formatted webhook url. Regex for validation: ^https:\\/\\/.*\\.slack\\.com\\/services\\/T[a-zA-Z0-9]*\\/B[a-zA-Z0-9]*\\/[a-zA-Z0-9]*$"},"slack_notification_integration_id":{"type":"string","description":"You can get notifications about release updates on Slack by setting this value. Make sure to send the integration ID found in Workspace Settings."},"status":{"type":"string","description":"The new status of the app version. Only the following statuses can be set externally: abandoned, completed_externally.","enum":["abandoned","completed_externally"]},"teams_webhook_url":{"type":"string","description":"You can get notifications about release updates on Teams by setting this value. Make sure to send the properly formatted webhook url. Regex for validation: ^https:\\/\\/(?:.*\\.webhook|outlook)\\.office(?:365)?\\.com\\/webhookb2\\/.*"},"approvals":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"due_date":{"type":"string","description":"A valid date in the future."},"summary":{"type":"string"}}},"description":"Tasks for the approval stage. Sending this value will replace the possibly already existing approval task list."},"automation":{"type":"array","items":{"type":"object","properties":{"event_name":{"enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed"],"type":"string"},"workflow_name":{"type":"string"},"pipeline_name":{"type":"string"}}},"description":"Automation events (workflow or pipeline runs) setup for specific event types. Sending this value will replace the possibly already existing automation list."},"timeline":{"type":"array","items":{"type":"object","properties":{"stage":{"enum":["release-candidate","approvals","testflight-upload","google-play-upload","app-store-review","release"],"type":"string"},"target_date":{"type":"string","description":"A valid date."}}},"description":"Timeline settings for the app version. Dates set here will appear in the sidebar. These deadlines serve purely informational purposes, no automatic action will take place at the scheduled times. Sending this value will replace the possibly already existing timeline."},"outgoing_webhooks":{"type":"array","items":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed","app_store_release_cancelled","app_store_release_completed","app_store_release_started","app_store_review_approved","app_store_review_cancelled","app_store_review_rejected","app_store_review_submitted","app_store_version_created","app_store_version_updated","app_version_added","approval_task_added","approval_task_changed","approval_task_completed","approval_task_deleted","approval_task_reopened","approval_tasks_completed","auto-upload_disabled","auto-upload_enabled","automation_added","automation_removed","google_play_automated_rollout_cancelled","google_play_automated_rollout_configured","google_play_automated_rollout_paused","google_play_automated_rollout_resumed","google_play_release_completed","google_play_release_notes_localization_added","google_play_release_notes_localization_changed","google_play_release_notes_localization_removed","google_play_release_started","google_play_rollout_percentage_changed","google_play_testing_track_release_completed","google_play_testing_track_release_failed","google_play_upload_completed","google_play_upload_failed","google_play_upload_started","metadata_localization_added","metadata_localization_changed","metadata_localization_removed","microsoft_teams_connection_changed","outgoing_webhook_added","outgoing_webhook_deleted","outgoing_webhook_updated","phased_release_disabled","phased_release_enabled","phased_release_paused","phased_release_resumed","release_candidate_auto_select_latest_build_disabled","release_candidate_auto_select_latest_build_enabled","release_candidate_build_selected","release_candidate_source_changed","release_description_changed","release_settings_changed","slack_connection_changed","stopped_managing_release","testflight_app_review_approved","testflight_app_review_rejected","testflight_app_review_submitted","testflight_distribution_start_failed","testflight_distribution_started","testflight_distribution_stopped","testflight_processing_completed","testflight_processing_failed","testflight_upload_completed","testflight_upload_failed","testflight_upload_started","testflight_what_to_test_added","testflight_what_to_test_changed","testflight_what_to_test_deleted"]},"description":"A list of event names that will trigger this webhook. These events correspond to specific actions or states in the release process."},"all_events":{"type":"boolean","description":"Indicates whether this webhook should be triggered for all events. Set to true to enable the webhook for every event."},"webhook_configuration_id":{"type":"string","description":"The unique identifier of the webhook configuration, that can be found in the workspace integration settings. This ID links the webhook configuration to the workspace."}}},"description":"COMING SOON. A collection of outgoing webhooks configured to trigger for specific event types. Each webhook can be associated with one or more events or set to trigger for all events."}}}}}}}},"/app-versions/{id}/apple-app-store/release":{"post":{"summary":"Release App Store app. - iOS only","description":"Release app","security":[{"token":[]}],"tags":["App Versions - Apple App Store Release"],"operationId":"CreateStoreReleaseIOS","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Release","content":{"application/json":{"examples":{"204 - Release":{"value":{}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - when the release version cannot be found on Apple App Store":{"value":{"code":"ERR_APP_STORE_VERSION_NOT_FOUND","message":"The app version is missing from App Store."}},"422 - when the release version is set for automated release":{"value":{"code":"ERR_CANNOT_BE_RELEASED_MANUALLY","message":"The app version is set for automated release.","details":{"app_store_version":{"app_store_state":"PENDING_DEVELOPER_RELEASE","release_type":"SCHEDULED"}}}},"422 - when the release version is in an incompatible state":{"value":{"code":"ERR_CANNOT_BE_RELEASED_MANUALLY","message":"The app version is set for automated release.","details":{"app_store_version":{"app_store_state":"READY_FOR_SALE","release_type":"MANUAL"}}}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}}}}},"/app-versions/{id}/apple-app-store/release/complete":{"post":{"summary":"Completes an in-progress Apple App Store phased release, releasing to 100% of users. - iOS only","description":"Complete a phased release, making the update available to 100% of users immediately","security":[{"token":[]}],"tags":["App Versions - Apple App Store Release"],"operationId":"CompletePhasedReleaseIOS","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Complete phased release","content":{"application/json":{"examples":{"204 - Complete phased release":{"value":{}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - when the release version cannot be found on Apple App Store":{"value":{"code":"ERR_APP_STORE_VERSION_NOT_FOUND","message":"The release version is missing from App Store."}},"422 - when the release version is not a phased release":{"value":{"code":"ERR_RELEASE_CANNOT_BE_COMPLETED","message":"The release version you are trying to complete is not a phased release.","details":{"app_store_version":{"app_store_state":"READY_FOR_SALE","release_type":"MANUAL"}}}},"422 - when the phased release is not in progress":{"value":{"code":"ERR_PHASED_RELEASE_CANNOT_BE_COMPLETED","message":"The release version you are trying to complete is not an in progress phased release.","details":{"app_store_version":{"app_store_state":"READY_FOR_SALE","phased_release_state":"COMPLETE"}}}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}}}}},"/app-versions/{id}/apple-app-store/release/continue":{"post":{"summary":"Continues a previously paused Apple App Store phased release. - iOS only","description":"Continue a previously paused phased release","security":[{"token":[]}],"tags":["App Versions - Apple App Store Release"],"operationId":"ContinuePhasedReleaseIOS","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Continue phased release","content":{"application/json":{"examples":{"204 - Continue phased release":{"value":{}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - when the release version cannot be found on Apple App Store":{"value":{"code":"ERR_APP_STORE_VERSION_NOT_FOUND","message":"The release version is missing from App Store."}},"422 - when the release version is not a phased release":{"value":{"code":"ERR_RELEASE_CANNOT_BE_CONTINUED","message":"The release version you are trying to pause is not a phased release.","details":{"app_store_version":{"app_store_state":"PENDING_DEVELOPER_RELEASE","release_type":"MANUAL"}}}},"422 - when the phased release version is not paused":{"value":{"code":"ERR_PHASED_RELEASE_CANNOT_BE_CONTINUED","message":"The release version you are trying to continue is not a paused phased release.","details":{"app_store_version":{"app_store_state":"PENDING_DEVELOPER_RELEASE","phased_release_state":"ACTIVE"}}}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}}}}},"/app-versions/{id}/apple-app-store/release/pause":{"post":{"summary":"Pauses an Apple App Store phased release. - iOS only","description":"Pause a phased release","security":[{"token":[]}],"tags":["App Versions - Apple App Store Release"],"operationId":"PausePhasedReleaseIOS","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Pause phased release","content":{"application/json":{"examples":{"204 - Pause phased release":{"value":{}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - The release version cannot be found":{"value":{"code":"ERR_APP_STORE_VERSION_NOT_FOUND","message":"The release version is missing from App Store."}},"422 - The release version is not a phased release":{"value":{"code":"ERR_RELEASE_CANNOT_BE_PAUSED","message":"The release version you are trying to pause is not a phased release.","details":{"app_store_version":{"app_store_state":"PENDING_DEVELOPER_RELEASE","release_type":"MANUAL"}}}},"422 - The phased release version is already completed":{"value":{"code":"ERR_PHASED_RELEASE_CANNOT_BE_PAUSED","message":"The release version you are trying to pause is not an in progress phased release.","details":{"app_store_version":{"app_store_state":"PENDING_DEVELOPER_RELEASE","phased_release_state":"COMPLETE"}}}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}}}}},"/app-versions/{id}/apple-app-store/release/settings":{"get":{"summary":"Gets the release settings for the app version","description":"Gets the release settings for the app version. - IOS only","operationId":"GetReleaseSettings","security":[{"token":[]}],"tags":["App Versions - Apple App Store Release"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Gets the release settings for the version","content":{"application/json":{"examples":{"200 - Gets the release settings for the version":{"value":{"earliest_release_date":"2025-02-16T09:26:01.000Z","phased_release":true,"release_type":"SCHEDULED"}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - when the release version does not exist in App Store":{"value":{"code":"ERR_APP_STORE_VERSION_NOT_FOUND","message":"The app version is missing from App Store."}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}}}},"patch":{"summary":"Updates the release settings for the app version","description":"Updates the release settings for the app version. - IOS only","operationId":"UpdateReleaseSettings","security":[{"token":[]}],"tags":["App Versions - Apple App Store Release"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Updates the release settings for the version","content":{"application/json":{"examples":{"200 - Updates the release settings for the version":{"value":{}}}}}},"400":{"description":"Bad request","content":{"application/json":{"examples":{"400 - when the release type is invalid":{"value":{"code":"ERR_INVALID_RELEASE_TYPE","message":"The release type must be one of: AFTER_APPROVAL, MANUAL, SCHEDULED (case-insensitive)"}},"400 - when the release type is not scheduled, but earliest release date is given":{"value":{"code":"ERR_NOT_SCHEDULED_RELEASE","message":"Only the release_type: \"scheduled\" can be given an earliest release date."}},"400 - when the earliest release date has an invalid date":{"value":{"code":"ERR_INVALID_DATE","message":"The earliest release date is invalid."}},"400 - when the phased release setting is not a boolean":{"value":{"code":"ERR_NON_BOOLEAN","message":"Phased release setting must have a boolean value, either \"true\" or \"false\"."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - when the release version does not exist in App Store":{"value":{"code":"ERR_APP_STORE_VERSION_NOT_FOUND","message":"The app version is missing from App Store."}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"earliest_release_date":{"type":"string","description":"Can only be set with release_type: \"scheduled\". The earliest release time the version will be released after approval. Must be a valid date time string."},"phased_release":{"type":"boolean","description":"Whether to release the version over a 7-day period or to all users immediately."},"release_type":{"enum":["AFTER_APPROVAL","MANUAL","SCHEDULED"],"type":"string","description":"case-insensitive"}}}}}}}},"/app-versions/{id}/apple-app-store/release/status":{"get":{"summary":"Gets the release status of the app version","description":"Gets the release status of the app version. - IOS only","operationId":"GetReleaseStatus","security":[{"token":[]}],"tags":["App Versions - Apple App Store Release"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Gets the release status of the version","content":{"application/json":{"examples":{"200 - Gets the release status of the version":{"value":{"app_release_status":"ready_to_release","phased_release_status":"INACTIVE"}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - when the release version does not exist in App Store":{"value":{"code":"ERR_APP_STORE_VERSION_NOT_FOUND","message":"The app version is missing from App Store."}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}}}}},"/app-versions/{id}/apple-app-store/review/cancel":{"post":{"summary":"Cancel App Store review","description":"Cancels App Store review. - IOS only","operationId":"CancelReview","security":[{"token":[]}],"tags":["App Versions - Apple App Store review"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Cancels the review submission","content":{"application/json":{"examples":{"200 - Cancels the review submission":{"value":{}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - when the store review submission does not exist in App Store":{"value":{"code":"ERR_APP_VERSION_SUBMISSION_DOES_NOT_EXIST","message":"The app version submission doesn't exist."}},"422 - when the app version is not currently under review":{"value":{"code":"ERR_MISSING_REVIEW_ID","message":"Cancellation is not possible. This version was not under review."}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS app versions."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}}}}},"/app-versions/{id}/apple-app-store/review/status":{"get":{"summary":"Gets App Store review status","description":"Gets App Store review status. - IOS only","operationId":"GetReviewStatus","security":[{"token":[]}],"tags":["App Versions - Apple App Store review"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Gets the app store review status","content":{"application/json":{"examples":{"200 - Gets the app store review status":{"value":{"release_management_review_status":"finished","app_store_review_status":"APPROVED"}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - The app version review is not requested":{"value":{"code":"ERR_REVIEW_NOT_REQUESTED","message":"App Store review has not been requested for this release."}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS app versions."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}}}}},"/app-versions/{id}/apple-app-store/review/submit":{"post":{"summary":"Submit release candidate for App Store review","description":"Submits the chosen release candidate for App Store review. - IOS only","operationId":"SubmitReleaseCandidateForReview","security":[{"token":[]}],"tags":["App Versions - Apple App Store review"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Submits the release candidate for review","content":{"application/json":{"examples":{"202 - Submits the release candidate for review":{"value":{}}}}}},"400":{"description":"Bad request","content":{"application/json":{"examples":{"400 - Bad request":{"value":{"code":"ERR_BAD_REQUEST","message":"Missing locale for localization."}}}}}},"409":{"description":"Conflict","content":{"application/json":{"examples":{"409 - when previous app store version is not in an editable state":{"value":{"code":"ERR_CONFLICTS_WITH_CURRENT_APP_STORE_VERSION_STATE","message":"ReleaseManagement::ErrorHandling::Conflict"}},"409 - when current app store version is pending developer release":{"value":{"code":"ERR_CONFLICTS_WITH_REVIEWED_VERSION","message":"ReleaseManagement::ErrorHandling::Conflict"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - when the release candidate has not been approved yet":{"value":{"code":"ERR_RELEASE_CANDIDATE_NOT_APPROVED","message":"The release candidate cannot be sent to App Store review. It has not yet been approved."}},"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - when the release version does not exist in App Store":{"value":{"code":"ERR_VERSION_DOES_NOT_EXIST","message":"The app version does not exist in App Store."}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS app versions."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"copy_primary_whats_new":{"type":"boolean","description":"If true, whats_new from the primary localization will be copied into other localized languages where whats_new is empty. The default value is false."},"localizations":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"The maximum length of this parameter is 4000 characters."},"keywords":{"type":"string","description":"The maximum length of this parameter is 100 characters."},"locale":{"type":"string","description":"You can find the [supported locales](https://developer.apple.com/documentation/appstoreconnectapi/app_store/app_metadata/app_info_localizations/managing_metadata_in_your_app_by_using_locale_shortcodes)."},"marketing_url":{"type":"string"},"promotional_text":{"type":"string","description":"The maximum length of this parameter is 170 characters."},"support_url":{"type":"string"},"whats_new":{"type":"string","description":"The maximum length of this parameter is 4000 characters."}},"required":["locale"]}}}}}}}}},"/app-versions/{id}/approvals":{"get":{"summary":"Gets a list of approval tasks","description":"Gives back a list of approval tasks.","security":[{"token":[]}],"tags":["App Versions - Approvals"],"operationId":"ListApprovalTasks","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Approval Tasks","content":{"application/json":{"examples":{"200 - Approval Tasks":{"value":[{"description":null,"due_date":null,"completed":false,"completed_at":null,"created_at":"2025-02-11T09:26:01.000Z","id":1,"summary":"task 1","assigned_user":null,"creator_user":null},{"description":null,"due_date":null,"completed":false,"completed_at":null,"created_at":"2025-02-11T09:26:01.000Z","id":2,"summary":"task 2","assigned_user":null,"creator_user":null},{"description":null,"due_date":null,"completed":false,"completed_at":null,"created_at":"2025-02-11T09:26:01.000Z","id":3,"summary":"task 3","assigned_user":null,"creator_user":null}]}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}}}},"post":{"summary":"Creates an approval task","description":"Creates an approval task under the given app version.","security":[{"token":[]}],"tags":["App Versions - Approvals"],"operationId":"CreateApprovalTask","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The created approval task","content":{"application/json":{"examples":{"201 - The created approval task":{"value":{"description":"Example Description","due_date":"2075-02-11T09:26:01.000Z","completed":false,"completed_at":null,"created_at":"2025-02-11T09:26:01.000Z","id":132,"summary":"Example approval task","assigned_user":{"avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png","email":"fry@bitrise.io","username":"fry","slug":"1be8af187e0f2f00"},"creator_user":{"avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png","email":"default-user@example.com","username":"default-user","slug":"default-user-slug"}}}}}}},"422":{"description":"Bad request","content":{"application/json":{"examples":{"422 - Bad request":{"value":{"code":"ERR_UNPROCESSABLE_ENTITY","message":"Validation failed: Summary can't be blank"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"assigned_user_slug":{"type":"string","description":"The user's slug to assign the approval task to."},"description":{"type":"string","description":"The description for your approval task."},"due_date":{"type":"string","description":"A valid date in the future."},"summary":{"type":"string","description":"The name of your approval task."}},"required":["name"]}}}}}},"/app-versions/{id}/approvals/{task_id}":{"delete":{"summary":"Deletes an approval task","description":"Deletes an approval task.","security":[{"token":[]}],"tags":["App Versions - Approvals"],"operationId":"DeleteApprovalTask","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"task_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The deleted approval task","content":{"application/json":{"examples":{"200 - The deleted approval task":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}}}},"get":{"summary":"Get an approval task","description":"Gives back an approval task by task Id.","security":[{"token":[]}],"tags":["App Versions - Approvals"],"operationId":"GetApprovalTask","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"task_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Approval Task","content":{"application/json":{"examples":{"200 - Approval Task":{"value":{"description":"Long description about this task.","due_date":"2025-02-06T09:26:01.000Z","completed":true,"completed_at":"2025-02-11T09:26:01.000Z","created_at":"2025-02-11T09:26:01.000Z","id":1,"summary":"Example Task","assigned_user":null,"creator_user":null}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}},"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"patch":{"summary":"Updates an approval task","description":"Updates an approval task.","operationId":"UpdateApprovalTask","security":[{"token":[]}],"tags":["App Versions - Approvals"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"task_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The updated task","content":{"application/json":{"examples":{"204 - The updated task":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"summary":{"type":"string","description":"The summary of your approval task."},"description":{"type":"string","description":"The detailed explanation of your approval task, providing additional context beyond the summary."},"assigned_user_slug":{"type":"string","description":"The user's slug to assign the approval task to."},"completed":{"type":"boolean","description":"The boolean flag of your approval task which marks it completed."}},"required":["name"]}}}}}},"/app-versions/{id}/beta-distribution/testing-groups":{"get":{"summary":"Gets a list of testing groups/tracks","description":"Gives back a list of testing groups/tracks.","security":[{"token":[]}],"tags":["App Versions - Store Beta Distribution"],"operationId":"ListTestingGroups","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Testing groups (ios)","content":{"application/json":{"examples":{"200 - Testing tracks (android)":{"value":{"internal_tracks":[{"name":"internal","version_code":null,"version_name":null}],"closed_tracks":[{"name":"closed testing 1","version_code":42,"version_name":"2.1"},{"name":"alpha","version_code":null,"version_name":null}],"open_tracks":[{"name":"beta","version_code":null,"version_name":null}]}},"200 - Testing groups (ios)":{"value":{"internal":[{"id":"c3700912-5944-4c1d-90f6-eae70addbe7f","name":"Internal Testing Group 1","created_date":"2023-01-29T08 =>44 =>07.961Z","is_internal_group":true,"has_access_to_all_builds":true,"public_link_enabled":null,"public_link_id":null,"public_link_limit_enabled":null,"public_link_limit":null,"public_link":null,"feedback_enabled":true,"ios_builds_available_for_apple_silicon_mac":true,"ios_builds_available_for_apple_vision":true,"beta_testers_total":2,"beta_testers":[{"id":"87229c70-882a-4357-8620-b434110cf120"},{"id":"4224084a-a830-46e1-82e7-331345b92c40"}]},{"id":"da6acbc2-5386-4908-95db-d1cff8c757f1","name":"Internal Testing Group 2","created_date":"2023-01-29T08 =>49 =>53.183Z","is_internal_group":true,"has_access_to_all_builds":true,"public_link_enabled":null,"public_link_id":null,"public_link_limit_enabled":null,"public_link_limit":null,"public_link":null,"feedback_enabled":true,"ios_builds_available_for_apple_silicon_mac":true,"ios_builds_available_for_apple_vision":true,"beta_testers":[]}],"external":[{"id":"f0c739e4-4d2e-4c18-bebe-5ca2c284f222","name":"External Testing Group 1","created_date":"2023-01-29T08 =>44 =>52.922Z","is_internal_group":false,"has_access_to_all_builds":null,"public_link_enabled":true,"public_link_id":"HFoiPjcV","public_link_limit_enabled":false,"public_link_limit":null,"public_link":"https =>//testflight.apple.com/join/HFoiPjcV","feedback_enabled":true,"ios_builds_available_for_apple_silicon_mac":true,"ios_builds_available_for_apple_vision":true,"beta_testers_total":2,"beta_testers":[{"id":"87229c70-882a-4357-8620-b434110cf120"},{"id":"400bbd4f-9311-4db0-9baa-ac1227690c1b"}]}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Invalid Google Play API credentials":{"value":{"code":"ERR_INVALID_CREDENTIALS","message":"The specified app does not have a valid Google Play Store API credential"}},"401 - App Store Connect API credentials":{"value":{"code":"ERR_UNAUTHORIZED","message":"The specified connected app does not have a valid App Store Connect API credential"}},"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}}}}},"/app-versions/{id}/beta-distribution/testing-groups/{group_id}":{"delete":{"summary":"Stop beta distribution on the testing group - IOS only","description":"Finish the beta distribution testing of the release candidate on the given group.","security":[{"token":[]}],"tags":["App Versions - Store Beta Distribution"],"operationId":"FinishBetaDistributionOnTestingGroup","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Finish testing","content":{"application/json":{"examples":{"200 - Finish testing":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - App Store Connect API credentials":{"value":{"code":"ERR_UNAUTHORIZED","message":"The specified connected app does not have a valid App Store Connect API credential"}},"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}}}},"patch":{"summary":"Start beta distribution on the testing group/track","description":"Initiate the beta distribution testing of the release candidate on the given group/track.","security":[{"token":[]}],"tags":["App Versions - Store Beta Distribution"],"operationId":"StartBetaDistributionOnTestingGroup","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Start testing (ios)","content":{"application/json":{"examples":{"204 - Start testing (android)":{"value":{}},"204 - Start testing (ios)":{"value":{}}}}}},"400":{"description":"Bad request","content":{"application/json":{"examples":{"400 - Bad request":{"value":{"code":"ERR_BAD_REQUEST","message":"There is no release candidate chosen"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Invalid Google Play API credentials":{"value":{"code":"ERR_INVALID_CREDENTIALS","message":"The specified app does not have a valid Google Play Store API credential"}},"401 - App Store Connect API credentials":{"value":{"code":"ERR_UNAUTHORIZED","message":"The specified connected app does not have a valid App Store Connect API credential"}},"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Do not allow testing on production":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You cannot publish an app version to production for testing."}},"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}}}}},"/app-versions/{id}/beta-distribution/what-to-test":{"get":{"summary":"Gets a list of \"What to test\" descriptions - IOS only","description":"Gives back a list of \"What to test\" descriptions and the default locale.","security":[{"token":[]}],"tags":["App Versions - Store Beta Distribution"],"operationId":"ListWhatToTestDescriptions","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"What to test","content":{"application/json":{"examples":{"200 - What to test":{"value":{"primary_locale":"en-GB","localizations":[{"id":"cf6683b7-f2d5-4100-889b-9df79f95ec37","whats_new":null,"locale":"ar-SA"},{"id":"a9da723c-b937-4210-91be-cc622c2499dc","whats_new":"Test API call","locale":"en-GB"}]}}}}}},"400":{"description":"No release candidate","content":{"application/json":{"examples":{"400 - No release candidate":{"value":{"code":"ERR_BAD_REQUEST","message":"There is no release candidate chosen"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - App Store Connect API credentials":{"value":{"code":"ERR_UNAUTHORIZED","message":"The specified connected app does not have a valid App Store Connect API credential"}},"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}}}},"post":{"summary":"Create the \"What to test\" description - IOS only","description":"Create the \"What to test\" description for the given app version.","security":[{"token":[]}],"tags":["App Versions - Store Beta Distribution"],"operationId":"CreateWhatToTestDescription","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The created \"What to test\" description","content":{"application/json":{"examples":{"200 - The created \"What to test\" description":{"value":{"id":"921db057-73eb-418a-b7ed-04f451e9dd85","locale":"en-GB","whats_new":"Awesome test description"}}}}}},"400":{"description":"No release candidate","content":{"application/json":{"examples":{"400 - Bad request - locale":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: locale"}},"400 - Bad request - whats_new":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: whats_new"}},"400 - No release candidate":{"value":{"code":"ERR_BAD_REQUEST","message":"There is no release candidate chosen"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Invalid App Store Connect API credentials":{"value":{"code":"ERR_UNAUTHORIZED","message":"The specified connected app does not have a valid App Store Connect API credential"}},"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"locale":{"type":"string","description":"In case of iOS platform here is the list of [supported locales](https://developer.apple.com/documentation/appstoreconnectapi/app_store/app_metadata/app_info_localizations/managing_metadata_in_your_app_by_using_locale_shortcodes)."},"whats_new":{"type":"string","description":"The description."}},"required":["locale","what_to_test"]}}}}}},"/app-versions/{id}/beta-distribution/what-to-test/{what_to_test_id}":{"delete":{"summary":"Remove the \"What to test\" description with the given locale - IOS only","description":"Remove the \"What to test\" description with the given locale.","security":[{"token":[]}],"tags":["App Versions - Store Beta Distribution"],"operationId":"RemoveWhatToTestDescription","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"what_to_test_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Remove description","content":{"application/json":{"examples":{"200 - Remove description":{"value":{}}}}}},"400":{"description":"No release candidate","content":{"application/json":{"examples":{"400 - No release candidate":{"value":{"code":"ERR_BAD_REQUEST","message":"There is no release candidate chosen"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - App Store Connect API credentials":{"value":{"code":"ERR_UNAUTHORIZED","message":"The specified connected app does not have a valid App Store Connect API credential"}},"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}}}},"patch":{"summary":"Update the selected \"What to test\" description - IOS only","description":"Update the selected \"What to test\" description for the given app version.","security":[{"token":[]}],"tags":["App Versions - Store Beta Distribution"],"operationId":"UpdateWhatToTestDescription","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"what_to_test_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Update \"What to test\" description","content":{"application/json":{"examples":{"200 - Update \"What to test\" description":{"value":{"id":"891960ff-7b4b-446b-808f-8e712022c4c4","whats_new":"Awesome test description","locale":"ar-SA"}}}}}},"400":{"description":"Parameter missing","content":{"application/json":{"examples":{"400 - No release candidate":{"value":{"code":"ERR_BAD_REQUEST","message":"There is no release candidate chosen"}},"400 - Parameter missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: whats_new"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - App Store Connect API credentials":{"value":{"code":"ERR_UNAUTHORIZED","message":"The specified connected app does not have a valid App Store Connect API credential"}},"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"locale":{"type":"string","description":"In case of iOS platform here is the list of [supported locales](https://developer.apple.com/documentation/appstoreconnectapi/app_store/app_metadata/app_info_localizations/managing_metadata_in_your_app_by_using_locale_shortcodes)."},"whats_new":{"type":"string","description":"The description."}},"required":["locale","what_to_test"]}}}}}},"/app-versions/{id}/google-play-store/localized-release-notes":{"put":{"summary":"Update release notes for different locales - Android only","description":"Update release notes for the given app version.","security":[{"token":[]}],"tags":["App Versions - Google Play Store Release"],"operationId":"UpdateLocalizedReleaseNotesAndroid","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Update release notes","content":{"application/json":{"examples":{"204 - Update release notes":{"value":{}}}}}},"400":{"description":"Parameter missing","content":{"application/json":{"examples":{"400 - Parameter missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: language"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for Android releases."}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"release_notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"The language code. Supported languages can be found here: [Google Play Supported Languages](https://support.google.com/googleplay/android-developer/table/4419860?hl=en)"},"text":{"type":"string","description":"The release notes text in the specified language. The maximum length of this parameter is 500 characters."}},"required":["language","text"]}}},"required":["release_notes"]}}}}}},"/app-versions/{id}/google-play-store/release":{"post":{"summary":"Release app for all users or for a fraction of users. - Android only","description":"Release app for a user fraction","security":[{"token":[]}],"tags":["App Versions - Google Play Store Release"],"operationId":"CreateStoreReleaseAndroid","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Full release","content":{"application/json":{"examples":{"204 - Fractional release":{"value":{}},"204 - Full release":{"value":{}}}}}},"400":{"description":"User fraction out of range","content":{"application/json":{"examples":{"400 - User fraction out of range":{"value":{"code":"ERR_INVALID_PARAMETER","message":"User fraction has to be bigger than 0 and smaller or equal to 1."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for Android releases."}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_fraction":{"type":"number","default":1,"description":"A number that is bigger than 0 and smaller or equal to 1. 1 means a full release."}},"required":["user_fraction"]}}}}}},"/app-versions/{id}/google-play-store/staged-rollout-schedule":{"delete":{"summary":"Delete staged rollout schedule - Android only","description":"Delete scheduled staged rollout for the given app version.","security":[{"token":[]}],"tags":["App Versions - Google Play Store Release"],"operationId":"DeleteStagedRolloutScheduleAndroid","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Delete staged rollout schedule","content":{"application/json":{"examples":{"204 - Delete staged rollout schedule":{"value":{}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Schedule not found for this release":{"value":{"code":"ERR_NOT_SCHEDULED","message":"Cannot delete the staged rollout schedule: no schedule exists for this release."}},"412 - Already released":{"value":{"code":"ERR_SCHEDULE_ALREADY_FINISHED","message":"Cannot delete the staged rollout schedule: already finished."}},"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for Android releases."}}}}}}}},"get":{"summary":"Get staged rollout schedule - Android only","description":"Get scheduled staged rollout for the given app version.","security":[{"token":[]}],"tags":["App Versions - Google Play Store Release"],"operationId":"GetStagedRolloutScheduleAndroid","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Get staged rollout schedule","content":{"application/json":{"examples":{"204 - Get staged rollout schedule":{"value":{"schedule":[{"id":"ab1de5df-7b10-49a6-91e6-46b08395ce71","has_run":false,"rollout_percentage":50.0,"when":"2025-02-12T09:26:01.000Z","last_run_at":null,"status":null}],"setup_location":"UTC","paused":false,"last_paused_at":null,"failure_reason":null}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for Android releases."}}}}}}}},"post":{"summary":"Create staged rollout schedule - Android only","description":"Create a staged rollout schedule for the given app version.","security":[{"token":[]}],"tags":["App Versions - Google Play Store Release"],"operationId":"CreateStagedRolloutScheduleAndroid","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Create staged rollout schedule","content":{"application/json":{"examples":{"204 - Create staged rollout schedule":{"value":{}}}}}},"400":{"description":"Percentage out of range","content":{"application/json":{"examples":{"400 - Invalid time format":{"value":{"code":"ERR_INVALID_TIME_FORMAT","message":"when must be a valid datetime string; given value: 'gibberish'"}},"400 - Percentage out of range":{"value":{"code":"ERR_VALIDATION","message":"Validation failed: Percentage must be within the valid range of 0.01-100","details":{"percentage":["must be within the valid range of 0.01-100"]}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for Android releases."}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"location":{"type":"string","description":"The time zone in which the schedule dates are provided. It can be any TZ database time zone or UTC if the dates are given in Coordinated Universal Time."},"schedule":{"type":"array","items":{"type":"object","properties":{"percentage":{"type":"number","description":"A number greater than 0 and less than or equal to 100 representing the release percentage, where 100 indicates a full release."},"when":{"type":"string","description":"A date in ISO 8601 string format specifying when to run the schedule."}},"required":["percentage","when"]}}},"required":["location","schedule"]}}}}}},"/app-versions/{id}/google-play-store/staged-rollout-schedule/pause":{"post":{"summary":"Pause staged rollout schedule - Android only","description":"Pause staged rollout schedule for the given app version.","security":[{"token":[]}],"tags":["App Versions - Google Play Store Release"],"operationId":"PauseStagedRolloutScheduleAndroid","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Pause staged rollout schedule","content":{"application/json":{"examples":{"204 - Pause staged rollout schedule":{"value":{}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Schedule not found for this release":{"value":{"code":"ERR_SCHEDULE_NOT_STARTED","message":"Cannot pause the staged rollout schedule: it has not started yet."}},"412 - Already released":{"value":{"code":"ERR_SCHEDULE_ALREADY_FINISHED","message":"Cannot pause the staged rollout schedule: already finished."}},"412 - No schedule exists for this release":{"value":{"code":"ERR_NOT_SCHEDULED","message":"No schedule exists for this release."}},"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for Android releases."}}}}}}}}},"/app-versions/{id}/google-play-store/staged-rollout-schedule/resume":{"post":{"summary":"Resume staged rollout schedule - Android only","description":"Resume a paused staged rollout schedule for the given app version.","security":[{"token":[]}],"tags":["App Versions - Google Play Store Release"],"operationId":"ResumeStagedRolloutScheduleAndroid","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Resume staged rollout schedule","content":{"application/json":{"examples":{"204 - Resume staged rollout schedule":{"value":{}}}}}},"400":{"description":"Percentage out of range","content":{"application/json":{"examples":{"400 - Invalid time format":{"value":{"code":"ERR_INVALID_TIME_FORMAT","message":"when must be a valid datetime string; given value: 'gibberish'"}},"400 - Percentage out of range":{"value":{"code":"ERR_VALIDATION","message":"Validation failed: Percentage must be within the valid range of 0.01-100","details":{"percentage":["must be within the valid range of 0.01-100"]}}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Schedule not paused":{"value":{"code":"ERR_SCHEDULE_NOT_PAUSED","message":"Cannot resume the staged rollout schedule: it has not been paused."}},"412 - No schedule exists for this release":{"value":{"code":"ERR_NOT_SCHEDULED","message":"No schedule exists for this release."}},"412 - Schedule already finished":{"value":{"code":"ERR_SCHEDULE_ALREADY_FINISHED","message":"Cannot resume the staged rollout schedule: already finished."}},"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for Android releases."}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"location":{"type":"string","description":"The time zone in which the schedule dates are provided. It can be any TZ database time zone or UTC if the dates are given in Coordinated Universal Time."},"schedule":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the existing schedule item, returned by the corresponding GET endpoint."},"percentage":{"type":"number","description":"A number greater than 0 and less than or equal to 100 representing the release percentage, where 100 indicates a full release."},"when":{"type":"string","description":"A date in ISO 8601 string format specifying when to run the schedule."}},"required":["id","percentage","when"]}}},"required":["location","schedule"]}}}}}},"/app-versions/{id}/outgoing-webhooks":{"get":{"summary":"Gets a list of outgoing webhooks.","description":"Gives back the list of outgoing webhooks associated with the given app version.","operationId":"ListOutgoingWebhooks","security":[{"token":[]}],"tags":["App Versions"],"parameters":[{"name":"id","in":"path","required":true,"description":"The UUIDv4 identifier of the app version.","schema":{"type":"string"}}],"responses":{"200":{"description":"Outgoing webhooks","content":{"application/json":{"examples":{"200 - Outgoing webhooks":{"value":[{"id":"c71c1a5a-afe5-4129-a1a0-c3e1df2e3765","created_at":"2024-05-09T15:52:21.000Z","events":["release_candidate_set"],"all_events":null,"webhook_configuration_id":"5623239f-28ea-4b8d-856e-8cb50073fade"},{"id":"75813a9f-33ce-4789-867c-3935f0aefe96","created_at":"2024-05-09T15:52:21.000Z","events":["release_candidate_set"],"all_events":null,"webhook_configuration_id":"5623239f-28ea-4b8d-856e-8cb50073fade"}]}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}},"post":{"summary":"Creates an outgoing webhook","description":"Creates an outgoing webhook associated with the given app version.","security":[{"token":[]}],"tags":["App Versions"],"operationId":"CreateOutgoingWebhook","parameters":[{"name":"id","in":"path","required":true,"description":"The UUIDv4 identifier of the app version.","schema":{"type":"string"}}],"responses":{"201":{"description":"The created outgoing webhook","content":{"application/json":{"examples":{"201 - The created outgoing webhook":{"value":{"id":"921db057-73eb-418a-b7ed-04f451e9dd85","created_at":"2025-02-11T09:26:01.000Z","events":null,"all_events":true,"webhook_configuration_id":"5623239f-28ea-4b8d-856e-8cb50073fade"}}}}}},"400":{"description":"Webhook configuration is not associated with the workspace of the app version","content":{"application/json":{"examples":{"400 - Missing parameters":{"value":{"code":"ERR_MISSING_REQUIRED_PARAMS","message":"There are missing params in the request: one of all_events or events must be present."}},"400 - Webhook configuration is not associated with the workspace of the app version":{"value":{"code":"ERR_INVALID_WEBHOOK_CONFIGURATION","message":"The given webhook configuration is not registered on the workspace."}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Webhook configuration does not exist":{"value":{"code":"ERR_NOT_FOUND","message":"Webhook configuration does not exist."}},"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The app version cannot be found."}}}}}},"409":{"description":"Webhook configuration duplication","content":{"application/json":{"examples":{"409 - Webhook configuration duplication":{"value":{"code":"ERR_DUPLICATED_WEBHOOK_CONFIGURATION","message":"A webhook configuration with id: 5623239f-28ea-4b8d-856e-8cb50073fade already exists."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed","app_store_release_cancelled","app_store_release_completed","app_store_release_started","app_store_review_approved","app_store_review_cancelled","app_store_review_rejected","app_store_review_submitted","app_store_version_created","app_store_version_updated","app_version_added","approval_task_added","approval_task_changed","approval_task_completed","approval_task_deleted","approval_task_reopened","approval_tasks_completed","auto-upload_disabled","auto-upload_enabled","automation_added","automation_removed","google_play_automated_rollout_cancelled","google_play_automated_rollout_configured","google_play_automated_rollout_paused","google_play_automated_rollout_resumed","google_play_release_completed","google_play_release_notes_localization_added","google_play_release_notes_localization_changed","google_play_release_notes_localization_removed","google_play_release_started","google_play_rollout_percentage_changed","google_play_testing_track_release_completed","google_play_testing_track_release_failed","google_play_upload_completed","google_play_upload_failed","google_play_upload_started","metadata_localization_added","metadata_localization_changed","metadata_localization_removed","microsoft_teams_connection_changed","outgoing_webhook_added","outgoing_webhook_deleted","outgoing_webhook_updated","phased_release_disabled","phased_release_enabled","phased_release_paused","phased_release_resumed","release_candidate_auto_select_latest_build_disabled","release_candidate_auto_select_latest_build_enabled","release_candidate_build_selected","release_candidate_source_changed","release_description_changed","release_settings_changed","slack_connection_changed","stopped_managing_release","testflight_app_review_approved","testflight_app_review_rejected","testflight_app_review_submitted","testflight_distribution_start_failed","testflight_distribution_started","testflight_distribution_stopped","testflight_processing_completed","testflight_processing_failed","testflight_upload_completed","testflight_upload_failed","testflight_upload_started","testflight_what_to_test_added","testflight_what_to_test_changed","testflight_what_to_test_deleted"]},"description":"A list of event names that will trigger this webhook. These events correspond to specific actions or states in the release process."},"all_events":{"type":"boolean","description":"Indicates whether this webhook should be triggered for all events. Set to true to enable the webhook for every event."},"webhook_configuration_id":{"type":"string","description":"The unique identifier of the webhook configuration that can be found in the workspace integration settings."}},"required":["webhook_configuration_id"]}}}}}},"/app-versions/{id}/release-candidate":{"get":{"summary":"Gets data on the release candidate","description":"Gets data on the release candidate.","operationId":"GetReleaseCandidate","security":[{"token":[]}],"tags":["App Versions - Release Candidate"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Release candidate","content":{"application/json":{"examples":{"200 - Release candidate":{"value":{"artifact_slug":"installable-artifact-slug","artifact_url":"https://artifact.url","build_slug":"rc-build-slug","build_url":"https://app.bitrise.io/app/ci-config-slug/build/rc-build-slug"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}}}}},"/app-versions/{id}/release-candidate/submit-for-beta-review":{"post":{"summary":"Submit release candidate for beta review","description":"Submits the chosen release candidate for beta review. - IOS only","operationId":"SubmitReleaseCandidateForBetaReview","security":[{"token":[]}],"tags":["App Versions - Release Candidate"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Submits the release candidate for beta review","content":{"application/json":{"examples":{"204 - Submits the release candidate for beta review":{"value":{}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Unprocessable entity":{"value":{"code":"ERR_RELEASE_CANDIDATE_MISSING","message":"There is no release candidate chosen for the app version.","details":"You can set a release candidate using the API by updating the app version with branch and workflow information.\nMake sure that the latest build there contains an installable artifact.\n\nYou can check how to do this here: api/release-management/api-docs#/Releases/UpdateRelease.\n\nAlternatively, you can also do this on the UI. Check the documentation out: https://docs.bitrise.io/en/release-management/releases/managing-the-release-process/selecting-a-release-candidate.html.\n"}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}},"/app-versions/{id}/release-candidate/upload":{"put":{"summary":"Uploads a release candidate","description":"Uploads the release candidate to the Store.","operationId":"UploadReleaseCandidate","security":[{"token":[]}],"tags":["App Versions - Release Candidate"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Upload release candidate","content":{"application/json":{"examples":{"200 - Upload release candidate":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}}}}},"/app-versions/{id}/release-candidate/upload/status":{"get":{"summary":"Gets the upload status of a release candidate","description":"Gets the upload status of a release candidate.","operationId":"GetReleaseCandidateUploadStatus","security":[{"token":[]}],"tags":["App Versions - Release Candidate"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Gets the upload status of the release candidate","content":{"application/json":{"examples":{"200 - Gets the upload status of the release candidate":{"value":{"release_candidate_build_slug":null,"release_candidate_id":"336e4af8-1442-4866-baed-36475cd27c64","upload_build_url":"https://app.bitrise.io/app/ci-config-slug/build/upload-build-slug","upload_state":"finished","processing_state":"VALID"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}}}}}},"servers":[{"url":"{baseURL}/release-management/v2/store-releases/v1","variables":{"baseURL":{"default":"https://api.bitrise.io","description":"The server base URL with the scheme."}}}],"components":{"securitySchemes":{"token":{"type":"apiKey","in":"header","description":"PAT necessary to use API calls","name":"authorization"}}},"tags":[{"name":"App Versions","description":"Only available in the Standard plan."},{"name":"App Versions - Release Candidate","description":"Only available in the Standard plan."},{"name":"App Versions - Approvals","description":"Only available in the Standard plan."},{"name":"App Versions - Store Beta Distribution","description":"Only available in the Standard plan."},{"name":"App Versions - Apple App Store review","description":"Only available in the Standard plan."},{"name":"App Versions - Apple App Store Release","description":"Only available in the Standard plan."},{"name":"App Versions - Google Play Store Release","description":"Only available in the Standard plan."}]} \ No newline at end of file diff --git a/docs/bitrise-api/api-reference/app-config-create.api.mdx b/docs/bitrise-api/api-reference/app-config-create.api.mdx index 62dbb805..3a72a6a7 100644 --- a/docs/bitrise-api/api-reference/app-config-create.api.mdx +++ b/docs/bitrise-api/api-reference/app-config-create.api.mdx @@ -1,8 +1,8 @@ --- id: app-config-create -title: "Upload a new bitrise.yml for your application." -description: "Upload a new bitrise.yml for your application." -sidebar_label: "Upload a new bitrise.yml for your application." +title: "Upload a new bitrise.yml for your application" +description: "Upload a new bitrise.yml for your application" +sidebar_label: "Upload a new bitrise.yml for your application" hide_title: true hide_table_of_contents: true api: eJy9Vl1v2jAU/SuWnzYJSjt1LzwNpk5i1VoE9GlCyCQXcJvYnu3AWJT/vnudUBI+Oq2bygMKzrnX5577Rc4dRJmVfsu733M+BOu0EkkvisC5iX4ChefTYtriMbjISuOlxiP+YBItYiaYgg2bS2+lg4ttmrCFtmyrM8uEMYmMBOEveIt7sXToiuNx24HPDEef2oANiEGMPulVpNVCLtuRBeEBzYywIgWPtAK/JomeMcwl2RJxClGVi+pEEsIIv8JnCz8yaQEv8TaDFnfRClLBuzn3W0N2DgNQS15QoAQG5/s63hICGXlQnh5rIXUeHVHIj13p+SNEvnFpiHpWhjaLhRfOawuzrUgTUsFY0sFLcNUlZ6Ddw/gnK2horxdH0rdYDAupIGZSsa/j+ztKUCqIX5NvQZ/DLJPAJRdWS8ShngUdOKOVKyP4cHl5zPX+Fu1eraWIY0lQkQwbYh2mL8Rwfer+PlbrqMzsvxBp5irFJhFLOMMkULk6pvKgROZX2spfqOBbcrk+5nKnPfuiM/WWRD6eys8A77aYXzYGuwbLbqzV9v+RAnI3S93yHC3kheW90jSIjA5FEoZHl3fwXtfJd6Ol6NRaDlEu8C3HU2axS/nKe+O6HbSTFzus1J315cUVpwGzm7hj4l7S68WxVj2simrkPnNEH7ew3Q+4fumvHQzaZNEuTaqBtwIRg+UYzclRftZvr6rIoO6hM/RGeo/2g/Hmp0hNAn+aV2Qp1UKfGAeLhYwkpnt0M56w3nAQFkf/WS2aT9IntZAJVNWDiEI9NCVh48wYbSlxzTRsNpt6GnYOWhwLRxIwAe/wVGHdfNoDSUMsN8CpVrvs22BCLyjjZSAhqa1QMqlQNeRfb8iGQLW984pdW+bYw0/fMYnAXBaVKHlV1GEj0STv1jZmva6xTFfUBYjM87lw8GCToqBjrAFLfxbwcS2sFHNKEq1m6egZ+2chEgcvxPNuVK2P96y2wU+S3lWrolJdiySjX/j4hLVb2/bFFLFVtRKX8vXn8sb2hJzszY/GSNHaWVCvGP8idlqbE8P78YR0q/4ppDomGys2tCLxO1DVQYHQ5eEs54lQyyxMSF76pDahldDsz6fQn9UDRXVSjMPGLQOhbwrrpEmel92P+dzhy1dnLSppd2jKzRRZ/wYVUY1c @@ -23,7 +23,7 @@ import Translate from "@docusaurus/Translate"; diff --git a/docs/bitrise-api/api-reference/app-delete.api.mdx b/docs/bitrise-api/api-reference/app-delete.api.mdx index 2d1ad490..6a77d487 100644 --- a/docs/bitrise-api/api-reference/app-delete.api.mdx +++ b/docs/bitrise-api/api-reference/app-delete.api.mdx @@ -1,8 +1,8 @@ --- id: app-delete -title: "Deletes an app" +title: "Delete an app" description: "Deletes an app by slug. Use with care, make sure you really want to delete the app. This action cannot be undone." -sidebar_label: "Deletes an app" +sidebar_label: "Delete an app" hide_title: true hide_table_of_contents: true api: eJzFVUtv2kAQ/iurPbUSj6RKL5xKFCqh9BEFcoo4LPaAN5hdd2YNpZb/e2dsQ0wgOVVpDmS9O49vHt9MoQmiHG3Y6cFjoe8AyTuTDqMIiKZ+BY7vZ+Wso2OgCG0WrOcrfQMpBCBlnDJZpuY7RWm+7KkHArW1IVGRQeiotVmBohxB7XyuEEya7tTWuKCCV3FlQ4UExEZPTRPLBiPxwOrO+aDmoHIXewc93dHBLInRaBZObWQqJAzMZ4DVxzhmYPzYrQ2zRmbQrPmIVEV3HMKQcQtolnMs1eg2N1YkMhMSPiP8yi0CWw+YQ0dTlMDa6EGhwy4TPQpo3VKXkiYEyrwjIHn/dHEh/479/rxlm5F3AVyQ11Y4/ScSkeLUhZ8/QRQkJJR4g60drGl5Dof8dfTVOe/XJlb3HBBQ+IcwuFnMEt6CcnkK5cGZPCQe7R/O7XtiuTrF8oOb7avnXntHIJ/P1WfMvpEZqCaAG0A1QvT4bqAYFfMl8cKkFouYBgPdZ7/UL/YkKfmFKow1uXJMWSgJIaNBn2Vtb27ZNEHP+v7monephR77aTMRvDWkYcwEH3InNOPmgIxt3MLumZ7Xtb1updAVjW6t0tA1ARMDao7h7Bh71e6w6cJ6orwwVsr3wp+h8WJhI8uFuh9Npmp4N1YLj+r6ELMMLBvSFnARairJU04sHgemJnmWeZSiHSdzu922k7k30NFcciuCXCjiW8cV//IsKJngRgGeRi1n38dTeZC61YFUpeEqewpr41qSxzNev1gBxXNL/p9tUBczwO/Qz1LDRSubvBVNx1abglh0cBjs3IEJxylvRTE3BA+YlqVc80RE2YF83Bi0Zi6Vk51hSc5MiIVJCd5Iwof7Zk98VK3VchbmvhGddOHGpLl88XHFbdlaQ+WMZZtGFCz1szR1FlqKJ/NAiHag8c3o22g6YnEZtscsWFUsaA7i4Cyul/SoUchv2XlFpShqjpXlQb5+elWjiXIvLWma8Tj6CzOh9Nc= @@ -23,7 +23,7 @@ import Translate from "@docusaurus/Translate"; diff --git a/docs/bitrise-api/api-reference/app-notifications.api.mdx b/docs/bitrise-api/api-reference/app-notifications.api.mdx index 86efa034..5934af91 100644 --- a/docs/bitrise-api/api-reference/app-notifications.api.mdx +++ b/docs/bitrise-api/api-reference/app-notifications.api.mdx @@ -1,8 +1,8 @@ --- id: app-notifications -title: "Updates the app's notification settings" +title: "Update the app's notification settings" description: "Updates the app's email notification settings with parameters" -sidebar_label: "Updates the app's notification settings" +sidebar_label: "Update the app's notification settings" hide_title: true hide_table_of_contents: true api: eJy9VsFu4zYQ/RWCl7aAHWeL7cWX1lmkaLBoGyQOeiiMgpbGFjcyyXKoeF1B/94Zkt5ItjaHNogPhkTNDN/MPL5hKxGKxutwkPM/W3kLHq1R9aIoAHFpH8HQ+qpbTWQJWHjtgra0JB9cqQKgCBUI5dw3KGCndC2MDXqjC8VmAiEEbbYo9jpUwimvdhBoBzmRQW2RIkvyrbO5pE2sAx9fbkrahD5O+wHZsReFAQ9RLZwTWDdbsjNklUPkFc0WToWKnj383WgPtEnwDUwkFhXhl/NWhoNjPwyekMuOM2djwHBlywNbFNYEMIEfe+hnn5AhtOeh7PoTFIGhe04vaED+as1fG6pY44Hfhnn8UQFVr7JNXYorTVAQqJimHJQXxcb62IAGqRyCCr5uNHnksD+KW4uo1zWIJ1VTBnOh6r064EQYeAI/EUWlzBa4G8OkJwwOm8iB1waXw/53cPw7ZSP3fZx5A9INu97xAjrCmhry/eXlebK/fyS/V+r4DrdjDEsJvR/b/UqV4i6x7xVhUPnVFl6C8u4cyoNRTais1/9Q/d4Sy/tzLL/ZIH62jXlLID+M9eeG9vYkl+IePJFWXHtv/ZuBIlRE7cqWSdeKKsoj6dtczmhbnLVH9etmTdTraRTpM03FiD4JauNr8q9CcDifURh9sU5n/ELb2dPlxTvJkngcGvecSQK7KEtrFsSRPDW+YKYYH+HwLMlZM6bRYcoe0+SSJboCVYJnFRqdRl+Nu8j8TMPkJBhF4+rfPUv59We1czWcSvGxxEMN7EmjNhs7ohMbKqgmJtxd3y/F4vYm6t/Vl9KxjulQ9/Jno0wVVUSqDOsj7hvnrGdWDHuy3+/7PTkGmMjYXDKsISCtGqLUT8+GjJ2YCCR3vc1+vVnyB25/SiR2mHhkMeyU6VmeT/xRxZUn2tybl///0pAaH+BzmLlaUYO7XJw2Ez9eKNh03hv8L3CfqFxRpuzYtmuF8ODrruNl4onnOxE9Pimv1Zp7xxcOjfxMZ26jaoQXsv32Lo+b70TvXjKaw5HRhukc5yG90eMj8bt3h+lWZJsZzVjS5w9px+mSgzy7nwlPNzl68Hly4UXbVU9bbhfLD7+Q9TpfgHa2ZCev9jxT6T9itS6VlAziWitrGuBN1C+ZgvIp5CkyPMSP8RDnB05rtBqnpztlwv+c16hL2yaJoIYe7dOnr3rk2h6tuTkrQv0vch7i5A== @@ -23,7 +23,7 @@ import Translate from "@docusaurus/Translate"; diff --git a/docs/bitrise-api/api-reference/app-roles-query.api.mdx b/docs/bitrise-api/api-reference/app-roles-query.api.mdx index 7728faeb..6d8f53cc 100644 --- a/docs/bitrise-api/api-reference/app-roles-query.api.mdx +++ b/docs/bitrise-api/api-reference/app-roles-query.api.mdx @@ -1,8 +1,8 @@ --- id: app-roles-query -title: "Lists group roles for an app" -description: "Lists group roles for an app" -sidebar_label: "Lists group roles for an app" +title: "List group roles for an app" +description: "List group roles for an app" +sidebar_label: "List group roles for an app" hide_title: true hide_table_of_contents: true api: eJzNVcFu2zAM/RVBpxVw6mzoyaelQDcU29qiyU5DUSg2k6i1JVeU02WG/32kbCdOk25YT7skskRSj+TjUy0R0sppv5HJj1regENrVD5JU0Cc2UcwtH/X3EXSqyXSWqqyzHWqvLZG0rYtwYWPy0wmfDhyNgccPVXgNjKSpXKqAE9xwwUZYOp0GbwTOc2rpbAL4VcgyJXMDRl3cZAOaUezYan8itYOnirtgG7yroJIYrqCQsmkln5Tsh96p81SNk308qorCtxfxQjFHMhSMEwNWSSwKkvrPGRirfIKUCgHiVBZoU0kCmXUEpx4R/erHEUGa8g58xM6g2I+OPKAlGz8pE6EMpkoc+UX1hX3YJbaALhdjoxiFNZvSzKSYKoitIRR0ncHk1cBFJf/4P67hrvpAEtrEJDjfhiP+W+/YF81ei7Y0tmqFNwMpHipNR6MZ/MBEeIHZJ96gFXl+fUitLxDbecPkHrJndnfIZCOa+l1iyZciIN8lXOKqaQ9FHis2ZQR/0TybHx2mMiV9eKTrUz2L/D/DBGcs+6+wOVxNAHLYTWxq2UYEEFdIYZ0tKcJWVkeoCWE25gJiYzpEOO6H4YmDp5xvWVOQ7YIbt1PV+Vyclt5X2ISk7c+nWuChXCqbbwen76X3Pt+4qecbZvQJMusmVR+1Y38rval/gKbHWnP23ij4DBij1Hr0nF4BSojklH+R6Xk1bgcyTr9q9WVF8Ea/l7Yw9ZeLxY61SoXtxfTmZjcXIaqnm9zpkBe+3wAnI06Hqg08GA/MTFtdYBs9ov5/Pw8LGYfgIawUJoNc/BIu4b48nFnyJUgmgGN2uCyb5czPuC+tYmE1lDfLXoa4oHlX3izV45tcT389DFNPhWx6fKoO04F/eZBTgYSGwLz3k6SiCYrAsMOdT1XCN9d3jS83Qo7PQqEXzmt5lxeVnaNvCYSL0gH4QDbdvTku9tO4U7E4QNwNIWeNIYZE/SZvmj5SBQaPBZB9d8C4z96HN6Q/65rpINRPzXck/acJ7D0A88D6WNV2ErQ54sZ2aqK6TKc18cwr91iIOz7qF4OcguBfwfKv+9S160aNM3Wvj161aNLsbfmIvEL8BsFgwU3 @@ -23,7 +23,7 @@ import Translate from "@docusaurus/Translate"; diff --git a/docs/bitrise-api/api-reference/app-roles-update.api.mdx b/docs/bitrise-api/api-reference/app-roles-update.api.mdx index ccaeca95..39775bda 100644 --- a/docs/bitrise-api/api-reference/app-roles-update.api.mdx +++ b/docs/bitrise-api/api-reference/app-roles-update.api.mdx @@ -1,8 +1,8 @@ --- id: app-roles-update -title: "Replaces group roles for an app" +title: "Replace group roles for an app" description: "Replaces the groups for a given role on an app. Only the given groups will be present for a role on the app after this call." -sidebar_label: "Replaces group roles for an app" +sidebar_label: "Replace group roles for an app" hide_title: true hide_table_of_contents: true api: eJzNVk1v2zgQ/SuETi3gjzToyadNihyC7W6CxDkVRkFLY5sNRaokZdcV9N/3DSnFcpwGu7lsAX9Q5Mxw5s3MGzWZp7x2Kuyz2ZcmuyXnrZH6Is/J+7l9JIP9RbsYZQX53KkqKIut7I4qLSEjwobE2tm68mJlnZBirbZkhLOahDVC4lNVE3Fj9D7JxuNOY6e0FksSlSNPJnQWel0Wh7KQq0AOT8qLXGo9yUZZkGsPxzIca5XL6BR8tBW5+HBdwEccjtmWH9dVIQNBr5JOlgRzPoZ7HNO9rtfCrvp7IW4g3BnyOMSOYsFKhg3Wjr7XyhGuCq6mUebzDZUymzVZ2Fes54NTZp217ej5VX/DcH9VDHdJkBSlLdRKUTESvq4q6wIVYit1DZylo5mQRanMSJTSyDUgeQcHpPaioC1pjv09zqhcDo4CeUQ7/S5xJE0hkLUAlMuvZNbKELlDlOzHOK7fFuYoI1OXMSvsJp47P3kVveIEnNy/aLm6+BK4emmLPVvOrQkoCF4OUjz95hm9ZuAC6uFmFXPZOWOX3ygPGUN+vIO7HWMUFHnWTCU4CEM6J/cce6DSv5RFOIrv8074rHzgVEZ7gsvEn4DW8oavrPHp7vOzM/77N4Z+YyQQ1cfz89NAHgzsM3/IJSr7ygRml/8QyeveknPWfS39+mXHolto8Y1lCqjqaIALeZZNca2fNn03t9NIDtPmqfBbyHpy254eaqehtgmh8rMptNVkqXCTp4my0+3Z5EPGpdsT6D0HkHy8KAprLuqw6Rj0gGyl/qT9oecuk71xVBizxjipdC24IVmgRxDSi8z8S7tsyTr1MzHjM2OwxqDfHVru6ocsK03DYvjSg7poWX1lT/N8s1qpXEkt7q7u5+Li9jry9+UTRMzTKuhBnCzUVYLMYyUc4yDuE+1B5hj73W43xL43AMoppWJBTcFj16Bi/jgIMnAoNELfDS7763rOB5zmFEjMJMrE+gDKGkg+TbnUk7Fe0pAy3YQ4QmTAW//7gEx1EehHmMIR5L/tMG26dojDkxlmNhhvMULeOwwDVPgGwLBC0yylpwen25a3UT6OXxuw3EqnuNvTVFWx89F/K4wgegWkd3cdTb4Xp8P3xRD6ejdc7HE04gnLR1T/YFDHifsWN36rwfwGBA55a7lxu5bnrKTzTyno8ZytHPRPCJkBTBpMOFV4VXYxYNzbhzlkl90cB27x1ULuuLjwG121MQeRKeNek2lp1jWgw3kyySQla67TIcc9Ro7rFoNRdwzGc/JLcfDvYBYeqzRNYtC2fZJPR7/U6JDtpTk3PBP/Abld5zk= @@ -23,7 +23,7 @@ import Translate from "@docusaurus/Translate"; diff --git a/docs/bitrise-api/api-reference/app-update.api.mdx b/docs/bitrise-api/api-reference/app-update.api.mdx index d3dc5a39..5842e0e1 100644 --- a/docs/bitrise-api/api-reference/app-update.api.mdx +++ b/docs/bitrise-api/api-reference/app-update.api.mdx @@ -1,8 +1,8 @@ --- id: app-update -title: "Updates an app" +title: "Update an app" description: "Updates an app by slug. Only updates the fields specified in the body." -sidebar_label: "Updates an app" +sidebar_label: "Update an app" hide_title: true hide_table_of_contents: true api: eJy9V92P4jYQ/1csv9ydxNdV1xeeyt5tVXRtb8XCU4WQkwzEt8FObQeORvzvnbGTTYBAr+1qeUDGno/fjMe/GUpuIS6MdAc+/qPkD2CsViKbxDFYO9dPoHB/eVz2eAI2NjJ3UuMWX+SJcGCZUEzkOYsOzGbFZsC+qOzAiurQpcDWErLEMptDLHGdMKn8fqSTw4D3uBMbiy44WslkLLx59KZzMP7HNEFveNgPRlEjF0ZswSFSD/kU1wTBEBKUUyhV6VY7kiRy4VJcG/izkAbQujMF9LiNU9gKPi65O+SkZ52RasOPFDsJg3V3iJkkYq0cKEfLFuzhV0sQyktTOvoKsSPohuJyEmytCyuRy1WMQNCgFNnKQx2fhzXHjCnYswmpsMnDlD3B4Y31obK3BmK93YJKPI4xKyz4HC+mzGlmweEvad9Rtk9j61UYWv5R16xkch2C12CNBnkzbPrpP8CQmMYNmOs4biejG8n/TkkCa1FkbhUZoeL0uvtKjgU5ttbGe2hVxKDLvLSrvIhQ5LrlncgKYHrN9imgSVO9stoss6kusoRFwIIlfHI7aWWUQeMw0joDocijgVxb6bQ5rAqTXXfbyLHF7NfvDgiTvpNIF/+qiiqlF68jJx1m4apbf0yZ/efA6HPOesQugYeYZyE7YJMsqzlOGDTtRUXWY3orXZsBD7pgiVZvHNtLm1IkwdLggoz8ldlcKxt44ofR6DKiL59R74WIyDrhCtvFfSEJH7oA3ImEzQIvvhySLXYdsYFbUN5fQlkoUbhUG/kXpvA1sXy4xPK7duxnXajXBPJj1/1M0bfBSmSP+NTwZd0bo82rgUJU2KNTnYSOG6e+cWPnHfMhurXDsu7LRx4opO7nnqJ46lxux0OUlYNIomULA6mHu9HgPaeOXE8tjwQ3IJok+LwmWAjV2PIMDG18hkMzEdwFe32v0CeNflCpJoQURBLYpHMcump3UhVhGGLOjKE1SvGsmSTuv4ltHsjqxiRQp/VWqx7d7p+NifPW1py0ulKYh86bRiN6k+9HzxTcbnlqrTsYbL2WMRH/7P5x7mca6jh3z5fNG1PVJglVFSxiX8GnN8oeizzXhor1tIr2+327imoDPY6lLkkwA2dxV2Gl/9QIEnZMCSARt5z9Np3TARVsCMTXJJa3tm4rVEvydEjmZ92kNUe+4DgdStPBNzfMMyH9AFB1/fD+/KhtUXT8PBnje0oRPJ2VZSQsLEx2PNI2Fquhfwa43AkjBY0YfuiWltZ44WuRWbgR2dtZ1dvesdZs3gmzflaK3pSfgfAXLnHUbc/xxyXKVs+KsITjj8Fjf05GGvULijv2ag161Lm7KbtssdjDZP7xF5SOqj8BW52QkhF7auD47bGG/u/5yO+VPBNqU3im5MEoUQH1q1MmefJMUi0orM5snFNMiIS+Ka5OlbIMPHU8PsuHo6saVW5rabqcJaL+GwSl8TE= @@ -23,7 +23,7 @@ import Translate from "@docusaurus/Translate"; diff --git a/docs/bitrise-api/api-reference/cache-item-delete-all.api.mdx b/docs/bitrise-api/api-reference/cache-item-delete-all.api.mdx index 9c37faa7..4c73e8e9 100644 --- a/docs/bitrise-api/api-reference/cache-item-delete-all.api.mdx +++ b/docs/bitrise-api/api-reference/cache-item-delete-all.api.mdx @@ -1,8 +1,8 @@ --- id: cache-item-delete-all -title: "Deletes all key-value cache items belonging to an app" +title: "Delete all key-value cache items belonging to an app" description: "Deletes all key-value cache items created by the builds of an app. Deleted cache items are no longer accessible and cannot be restored." -sidebar_label: "Deletes all key-value cache items belonging to an app" +sidebar_label: "Delete all key-value cache items belonging to an app" hide_title: true hide_table_of_contents: true api: eJzNVU1z2jAQ/SsandoZDEknvXAqmdAZJv3IBHrKcJDtBZQYyZVkUurxf+9b24AJpL1lmgORpbe7T7tvV6X0lBROh60cPpTyjpy3RmWjJCHvZ/aJDPbn1bwnU/KJ03nQFlvyhjIK5IXKMvFE22ijsoJEopIVCR1o7UXiSAVKRbwVAZtxobPUC7sQygiV533RuEiPjJQjYazIrFmSE6pmoeOMYMRAY2wQMQlHPlhHaV/2ZFBLD45yzyKqHUpQtjk5xYQnKSjX2xHHidI6dATycJArp9b4dL5OwfE9R3kufFYsgTNAYQfco3ZHMyJXYYW1o5+FBiU5DK6gnvQItlZyWMqwzdnOB6fNUlacS/DPrfHk+fzDxQX/O477/VZWPXl17uhapeIe0ZADxE2sCWQCw8As00l94cGjZ2x5SsPGj5SwYe44PUE3JNZItFrSOb78x1QuT6n8MKoIK+v0b1z8LblcnXL5Bml8toV5SyIfz9VngtgOPSSm5DZQ8dg5696MFFhBzCvLim9kXkscGh3KAeL6QblTcDU4tIQHytd8my4oXAaDVQi5Hw5gp/uxRhhPfW0Hm4v+pWQd72bHlLk39EZpas0IqmiHx54lfNzS9tBH142/qDaI2CJqTNq+WpFKyXEXnB1Kr/odtYqss/vSWcXfC3um3xYLnWgU7X48nYnR3UQsrBPX+zvzoNEh6xBnUFtVldRVPb6YmBZ5bh0X8DiZz8/P3WTuHPQkyq8ZiKJ57BpU/9MByJmAaAhjoxPs62TGB1y35iJ1aVBx68NamQ7y3xM7Jp67kJIItp3S8sXcLw8q/p+egEYJgX6FQZ4pVLxqk1620n/glmONDzvju6t+iHmFlDGyLGPl6YfLqoq3MWgdP45YbpTTKmYR8DuhPa/RZwuVefpLot7dt2/De9F5Ts6S3mnasKDrhOILS+S3+/RUc2BbTTOX5pj7Iw8dw5Mxwz27nw434y/j2RhwnuHHDfVUN1S74ABneb3stIYF/1a9V0zKsmlXpHaHb45etWhvuUNzmuaYcn8AsAL/Ag== @@ -23,7 +23,7 @@ import Translate from "@docusaurus/Translate"; diff --git a/docs/bitrise-api/api-reference/cache-item-delete.api.mdx b/docs/bitrise-api/api-reference/cache-item-delete.api.mdx index d84620f6..a82f8921 100644 --- a/docs/bitrise-api/api-reference/cache-item-delete.api.mdx +++ b/docs/bitrise-api/api-reference/cache-item-delete.api.mdx @@ -1,8 +1,8 @@ --- id: cache-item-delete -title: "Deletes a key-value cache item" +title: "Delete a key-value cache item" description: "Deletes a key-value cache item. Deleted cache items are no longer accessible and cannot be restored." -sidebar_label: "Deletes a key-value cache item" +sidebar_label: "Delete a key-value cache item" hide_title: true hide_table_of_contents: true api: eJy9VUtv4jAQ/iuWT7sSgXbVvXBaqrIS6j6qQk8VB5MMxG2wvbZDl43y33fGCZBAWlU9wAHMeMbzzeObKbiDOLfSb/nwseB3YJ1WIhvFMTg308+gUD4v5z2egIutNF5qFPEbyMCDY4I9wzbaiCwHFos4BSY9rPusuk8aMtS1wJRmmVYrsEwEF3KRAROKFJXSni2AWXBeW0j6vMe9WDkEwPdOovAgRzzagBWEZpIgniCOyE+UBNdobIQVazxaF2JrBzAyhrksX6GeQi2UCGOiWiJJwwif4tnCn1wiHD70Noced+hoLfiw4H5ryM55K9WKl2Xv2McMQ5/cML1kPm2mh3lNgVZAkwOCRhAy+TCMOSk7o5UDR/dfLi7opw3t9y0ve/yq6+paJOwevWEZ0G+slQflSQ0TlMk45Hzw5Ei3OIWhF08Qk6GxVCEvKxBrrLVYQRde+hCUy1MoD0rkPtVW/gtpOh+Wq1Msv7A7v+tcnRPI1676TNC3RY6yKdgNEmlsrbZnA4WokFOpJtI1mIY9OuQD9OsGxY5I5eDQ0ChudXeJVi7gr8iZ2wwfSL03bjjAd2R/IdGtg77Ug81F/5JTX+9m1ZRiqeCOkkSrEXZJPaz2qPGNW9geyHVdvRcFg4gsosqk5lkKIgFLrOgcgq++O6o7NGT7+LGS/i91B/+WSxlLLOL9eDpjo7sJW2rLrvcx0+yTPmsAJ6W6yiIOVW4Hxqa5MdpSQdvJfHl5aSZz90CPYztIUsQiOpQq7IZvB0XKBDYR4BhpOPs5mdEF1a0KJJQGO0A7vxaqofn2huBHC6U4tO/ZdktVTw9//cBkAutW1qkr6oZ+JCI5VB02dkOjp+mmPbOxR1PMBJkWxUI4eLBZWZIY56mlHYvHjbBSLKi2tJWkozPSaSkyB2+k5dN9vQI+s8by6oxi16qK+jQkEP/hEfPZXHRhY33E/7sX2wfQtRNaztGgZhOlq9IhZhrfsD4ZeDQt9nPqZvxjPBujOm2TNpWfA5XrAznoBHfM8QoFfVMKO02KohoUZbnXr65etaij3GlTruY4b/8DdnVLAw== @@ -23,7 +23,7 @@ import Translate from "@docusaurus/Translate"; diff --git a/docs/bitrise-api/api-reference/cache-item-download.api.mdx b/docs/bitrise-api/api-reference/cache-item-download.api.mdx index 84a22eeb..bd0c36c3 100644 --- a/docs/bitrise-api/api-reference/cache-item-download.api.mdx +++ b/docs/bitrise-api/api-reference/cache-item-download.api.mdx @@ -1,8 +1,8 @@ --- id: cache-item-download -title: "Gets the download URL of a key-value cache item" +title: "Get the download URL of a key-value cache item" description: "Gets a download URL of a cache item." -sidebar_label: "Gets the download URL of a key-value cache item" +sidebar_label: "Get the download URL of a key-value cache item" hide_title: true hide_table_of_contents: true api: eJy9VVtv2jAU/iuWnzaJkHbqXnga1boKdZcK6FOFJpMciNsQe7YDY1H+e89xAiSQTl01lQcw9rl85/adgluIciPdlg/uC34LxqpMpMMoAmun6hEyvJ+Vsx6PwUZGaicVXvFrcJYJFqtNlioRs7vxV6YWeBOJKAEmHaz6vMedWFo0wB9hG6xFmkPg3znaUxqMIGujGO3564DUgp1NVNfCiBU4BOXRtSEMtWY2zZcol6EU3gitg/pGkoQWLsGzgV+5NIBunMmhxy26Wgk+KLjbatKzzshsycuyd+xjirGMPlNkDk+H2JhTbA778CE+gGhEIuNXI5mRsNUqs2Dp/cPZGf200f24QZuRyhxkjl4x/lRGPqnhgyWR4tSFmj9A5Ci5hkrgZOUgFu4lUnXAP3OTdsGuPj1+0QX3EvtkjBkA6/4f7hX2qVjCc2AIyvkplLtM5C5RRv7xpXs7LBenWL4rx76oPHtLIB+76jNC3waHn03ArMGwK2OUeTNQiApHPVHEBkvw6jQ0Ax6iUxsWu+Euw8OE4XVr3MqwQR7WR1Exh29Xnjin7SBEg7I/l+jcQl+qcH3WP+c0cTsqnFBEFehhHKtsiL1Sc+EeO9q4ge1h7C8re4FXCEgjqFRqBkgAacJwjLKTY5+1O6z71Of82FhJ/xeqgxkWCxlJLOX4ajJlw9sRWyjDLvcxEzVLlzaAk1BdaxH5WrcDY5Nca2WoLu1kbjabZjJ3Bnocm0KSYIqrAm8z7IlPB0HKBLYSIME1nH0bTemB6lYF4kuDraCsW4msIekXEJHy6QraL5sGYfOjBVYcuvrFu6wqkIPfLtSpwEKUdS6KulXvaT4sig4am6jRrfRyvB72DYv9l2CUZKUo5sLCnUnLkq6RMQ2tZzyuhZFiTnWjdSgtnXFgFiK18JcI343rxfOeNbZmZ0C7NsyoB30W8R8eManNDetX5Wv8/8tGfQXAdnrLGSrUw0IZq2Ro8LRraJ+wGpHBnoyur6YoS/uiPaaPfkzrA1nvRHY8vxUE+qYUdqoURUUCWP2dfPX0rEYd4k6aEjVDRn0Csa1eyw== @@ -23,7 +23,7 @@ import Translate from "@docusaurus/Translate"; diff --git a/docs/bitrise-api/api-reference/member-add.api.mdx b/docs/bitrise-api/api-reference/member-add.api.mdx index 0203953f..9a8213a1 100644 --- a/docs/bitrise-api/api-reference/member-add.api.mdx +++ b/docs/bitrise-api/api-reference/member-add.api.mdx @@ -1,8 +1,8 @@ --- id: member-add -title: "Adds a member to the organization" -description: "Adds a member to the organization" -sidebar_label: "Adds a member to the organization" +title: "Add a member to the organization" +description: "Add a member to the organization" +sidebar_label: "Add a member to the organization" hide_title: true hide_table_of_contents: true api: eJy9VcFu2zAM/RVDpw1w6nbrKaelRQcUw9aiSU9DMMg2E6u1JU2Sk6aG/32kZSd24xY9bMshUaRH6pF8pCpmISmNcDs2/VmxWzBWSZ7PkgSsXahHkLi/rJchS8EmRmgnFG6xWZragAcFFDGYwKnAZRAos+ZSPPMGEzLH1xatWX/bMnSlNJjm33WKrryPCU9TtNHc8AIc0mj4DC/tOwpsXq7RQCLcH03aHUFQzV2GawO/S2EAr3GmhJDZJIOCs2nF3E6TnXVGyDWrKUICg3UXKt0RIlHSgXS05FrnImnujR4scamOXan4ARJHMRgK0AmwdIogkY/diJ+XWW3TmXLHj8jXtGE1ptD7/XR6Rj9DB5cGuANK5D9mj6mkbI8dlBaMr8pozIg4H6N+L3npMmXE81/lb4wyvwo7RnXP5vMxm6/KxCJNQf5nKufHVH4oF6xUKf9nVpALdmGmqD+1so0H6qgpiwbdHFVd49WRF69FKApg03VwaVA+LHNO22kUcS1OYoE3WTgRKtqcnpwxar1uCM0pAM8RJ4ySM5REO4X2RNHHN9gdWv/C+5s0BhOymHiTdhRkwFMwpMzR6faq31krx26cDZyhN0r63WFkXD3xQufQa5peTwi5UseVvVmtRCJ4HtxdzRfB7PYa62yCi31+aIYKl/eCJFArA540MhgmIZiXWitD9Romfrvd9hPfOQj3XHNwFnclyuXLAUjcUWWAQ6d32ffrBR1QjX0gTRnDRikFlz3ke56JQU56Y/d9b4yvnYMnF+mcY43qNvSqVezL9ydk095j0YkWNZiRzhFeVTG3cG/yuqZtLLChxxGXG24Ej6ke9DQJS2vskBXPLbwRx4e7dpB/DMZesNEQOk1KEuSG5yX9w+UjKrT32tVLxLaaJFL++NJfPVmQk4P50cSow86COkK7N7HL3ki4vZkvEBy3L2WhUrIxfEuvFn43VJX2CUdAs1exnMt1ydeE9T6pjWjqD7vwsenCdkFRjSbjZXv6QOibwho1qSrf41jYDu+PXrVoU9uhqTZLZP0H0Twu/A== @@ -23,7 +23,7 @@ import Translate from "@docusaurus/Translate"; diff --git a/docs/bitrise-api/api-reference/org-show.api.mdx b/docs/bitrise-api/api-reference/org-show.api.mdx index e60cbceb..c221a640 100644 --- a/docs/bitrise-api/api-reference/org-show.api.mdx +++ b/docs/bitrise-api/api-reference/org-show.api.mdx @@ -1,8 +1,8 @@ --- id: org-show -title: "Get a specified organization." +title: "Get a specified organization" description: "Get a specified Bitrise organization that the user is part of." -sidebar_label: "Get a specified organization." +sidebar_label: "Get a specified organization" hide_title: true hide_table_of_contents: true api: eJy9VVFv2jAQ/iuWnzYJSDt1LzyNSl2Fqm1VoU8TqkxyIW5D7NkOjEb577uLE0ggbHuoykNw4jvfd3efvyu4hTA30u34+GfB78FYlYl0EoZg7Vy9QIbfF+ViwCOwoZHaSYWf+C04JpjVEMpYQsSupTPSAlNmJTL5KsiMuUQ4fADLLRgmLdPCOKbiER9wJ1YWj+ZtB8sxjtJgqrdphHFwe2gTtUUPdBZrcIiwgtrFM0+OYts0X6FThi7NMf6LJHMtXIJrA79yaQADOZPDgNswgbXg44K7nSY/i1llK15SAQxYjRjB0v6niwv664L4cYdnhipzkDnaFVqnMqzwBM+WTIrTEGr5DKGj/Ayl7qQPEAn3H1Zig2bmSWLQp9ykPcgrQNhhA1m4ewpV7qHVVhKxrsCQma9Uj7/aZlXN91vCGLGjSjpY239jxHRlP7KqI30bxJczePB31rH+DfhVX3euRcQesOFg3du1aY3XRKzOAPVQLk+hPGYid4ky8hW5955Yrk6xfFeOfUVavCeQz339mWJs7HrKZmA2qBc3xijzbqAQFYpLokh0VlC5k0aMedBRqKBopKREE1sh9XpUXT+eOKftOAiElqOl18SRVMHmYnTJSUQatZ0Rag9sEkUqmyAfark93DMt72B3ELFaY4eVw5A8ht6lFrUEROTvcq+Mnz13UnOxyvD4sJLeY9UjdnEsQ4nteriZzdnkfspiZZo5gDmTxkuXtoCTUd1PEVb97CbGZrnWylDtu8XcbrftYjYHDBpp4Sk4i18z7PuXgyFVAukCqNmtYN+mc9qgvvlEqtZgu5V1a5G1LI9nXJsINMI69SgOPH2D4egb5eC3C3QqsCFlXZOipuXx4Bzw8X7GIc0STIaMimIpLDyatCzpM4qfoUGPy40wUiypPTRLpaU1cj8WqYW/pPbhoR6ZH9m5kdsLvqFeRrzbiDSnN1y+IBFb47lcoG1NPQLmt4nG2rUcT3SArtb++t7ezNGWFLZL+peK9PWCTu8FdXwbPAR6loMzLkXhr1RZ7u391lmPOsXGmmq0QA36A7y6TQc= @@ -23,7 +23,7 @@ import Translate from "@docusaurus/Translate"; diff --git a/docs/bitrise-api/api-reference/organization-group-add.api.mdx b/docs/bitrise-api/api-reference/organization-group-add.api.mdx index 24c3eefa..9f7a659f 100644 --- a/docs/bitrise-api/api-reference/organization-group-add.api.mdx +++ b/docs/bitrise-api/api-reference/organization-group-add.api.mdx @@ -1,8 +1,8 @@ --- id: organization-group-add -title: "Adds a group to the organization" -description: "Adds a group to the organization" -sidebar_label: "Adds a group to the organization" +title: "Add a group to the organization" +description: "Add a group to the organization" +sidebar_label: "Add a group to the organization" hide_title: true hide_table_of_contents: true api: eJy9VUtP20AQ/ivWnlopwdByyqkBUQlVLYiEUxWhiT2JF5zd7e46IVj+753x2sQhBnFoySHZ7M7jm8c3UwqHSWGl34rR71Jco3VaQT5OEnRuqh9Q0f2smg1Eii6x0nip6UqM09RFEC2tLkzkdeQzjLRdgpJPUIsMhIelI2XRvXaCLGmDtv53mZKl7vOwtjeENCV9AxZW6AlRDW3ff1crcnmxJAVF4uFp2NxIFjXgMzpb/FNIi+TS2wIHwiUZrkCMSuG3hvWct1ItRcXBsjA6f6bTLUskWnlUno9gTC6T2m987xhLeWhKz+8x8RyD5WC9RMevAeChQ/q8zG9IbAoeDqBXfOEMJTNY/XJ8wj/7+ucWwSOn8f9ipzxyqvuDotfTPnC3CgqfaSuf/iVCtFbbu5V7E83XQzTftZ3LNEX1wVBOD6H80j5a6EJ9ZFYIC7Es08xFo11tgRkzEvEec+OyJVYV193pSNKhXbcELWxOSpn3xo3iGIw8mkty5PBI6nh9fHQimFntuJkw/gCRZolWY+qIZt484yQbP3C7Y/ZZsDesFYasMQwqDdMzhBQtN2XvHHvV7rjpxnZy7Rkja5zzm91EuHiElclxx4oOG6Ra6MO6Xi0WMpGQRzcXk2k0vr6kKtvo7Dk9PC2lzzsxslDTBJD4jqv2fVIYoy1Xaz/vm82mm/fWwEBQt0gWzNE7ulXULN92goydegxpqHSc/byc8gOXOARSV3FQ98kKVEfyHftgLyWdmfquXRIK5/HRxyYHKlDVBF423fpyzwzEqLMImoal/su4xUm6LOfg8NbmVcXXVFzLK5COa7AS5lwM3jrS8ZnIsYDc4RtRfLpppvTnqG859UbQ9qPiZlxDXvA/Oj5Qd3YWWTUj2aYfGVR4Pg+uh1M2slM/GBbVoNVgNhj/puysMw2uryZTEp43S3ClU9axsOGVRN81VG1CvkmgvitFDmpZwJJlg02mEA/8fQY+1AxsDhxVbzJeUjMEwt8cVq9KWQZ+U2Fb+fD0qkaT2laaazMj1H8B1nsm3w== @@ -23,7 +23,7 @@ import Translate from "@docusaurus/Translate"; diff --git a/docs/bitrise-api/api-reference/pipeline-abort.api.mdx b/docs/bitrise-api/api-reference/pipeline-abort.api.mdx index a37be0ad..b09c2f90 100644 --- a/docs/bitrise-api/api-reference/pipeline-abort.api.mdx +++ b/docs/bitrise-api/api-reference/pipeline-abort.api.mdx @@ -1,8 +1,8 @@ --- id: pipeline-abort -title: "Aborts a pipeline" +title: "Abort a pipeline" description: "Aborts a pipeline. You need to provide the app slug and the id of the pipeline. You can add an abort reason, choose to skip notifications and make the abort with success state." -sidebar_label: "Aborts a pipeline" +sidebar_label: "Abort a pipeline" hide_title: true hide_table_of_contents: true api: eJzVVs1v2jAU/1csnzYJSDt1F06jUydV07aqsMNUocokD+ISbM92YF3E/7737AQSyHboodI4gHl+3x+/54o7SEsr/TMfP1T8DqzTShSTNAXnZnoNCunz/aDikyzTalL6/EidD3gGLrXSeKmRxCcLbb1jghlpoJAKRuyHLpkCyJjXzFi9lRkwnwMTxjBXlCsmVBYIMmN6GU5d4VQoJrKM0Q+pZxYE+jhgaa61A9Lr1tIwpb1cylSQKy5o3Yh1bSvI7aTPmStDZMx54WHEB9yLlcNgeGPUcYxKG7BB0W2GUTVXw6AHZYywYgMecxWSdpKDOjDkU8iFFAx1WFMkcRjhczxb+FlKC2jB2xIG3KU5bAQfV9w/G5Jz3kq14nvKftfGXe0RJu1o5uBmIL7M0jwyg/PXOnsmjlQrD8rTEeMo6gQnT44cqc5V6cUTpL5j9IGHxD3GwuFV/Ev1eKzrgUQq4mOniFQJbBmshZdYF/Kgrefc/V7NR7aF1gUIRXw9xnr46HPa4ofUx6ZqtcJpnvdEcAZ1R+ffXVzQT1fdt8/kzlXf1bXI2H0sBup+cR26GdxgSsQK+mofo726uDx35bsSOPjayt+QvaovV+e+fNWefdKlek1H3vfV5xZtW8RKNgW7BcturNX21ZxCr7Dvch0ASrsISzjtY56gVZdUDerskwO0JVULI/ZJA2cu+B+xrLQFqsi9N26coCY5Wkg062AkdbK9GF1ywohmZ0wpluju6Xo4eI06PsPzEaauo75hEBiSxDCK1JiVg8jA0lT0LqO/6p3UHRqyfaoMtVH+74/YdvNLbEwB56jSpLkfTGoA7YGPeuSlWuqeMV8ip8Reub+Zztjk7pYttWXXh9TSIpK+aOWHmOpmEmlopm7+2LQ0JtavW7PdbteuWaNgwLHrJDEW4B1SFTbdhyMjJRx7FRCtWsa+3M7ogtojBhI6YBA6biNUi/Ns9fMT5Gytkv/ynRC7zsMvn5hCyLBGQuarevAeaNxpDYxbC//4rEB6d0PH8cNpyml8UbyqFsLBd1vs90TGVrX0KsPjVlgpFtQe9NyQjs44+EtROPhHmt/c1wvpLWu9SnojaYZK0URtRVHSPzyuccRaL5jwFHmJ/e6L5QUutHO3xwdpM9qUkcjxMdodzkjPUcMZBlMMUYKAxfh/8s5bMHv3bTpD5kX9MtrojGSs2NHqx+/grTaH50SgVbwQalUGJOdRJ6ER7dMumK0DmNUHiqo3H6coFwOhbwqrV6SqIlRiVzX88eqvEnVqG24qzxy9/gPSrDko @@ -23,7 +23,7 @@ import Translate from "@docusaurus/Translate"; diff --git a/docs/bitrise-api/api-reference/pipeline-rebuild.api.mdx b/docs/bitrise-api/api-reference/pipeline-rebuild.api.mdx index c62d8400..505eb5a3 100644 --- a/docs/bitrise-api/api-reference/pipeline-rebuild.api.mdx +++ b/docs/bitrise-api/api-reference/pipeline-rebuild.api.mdx @@ -1,8 +1,8 @@ --- id: pipeline-rebuild -title: "Rebuilds a pipeline" +title: "Rebuild a pipeline" description: "Rebuilds a pipeline. You can rebuild the whole pipeline or only the unsuccessful and subsequent workflows by setting the partial flag to true." -sidebar_label: "Rebuilds a pipeline" +sidebar_label: "Rebuild a pipeline" hide_title: true hide_table_of_contents: true api: eJzNVt+P2jgQ/lcsP91JQHar9oWnY6uttDrdFQF9qCp0cpKBuGtsn+0spVH+9844CSTA9mFVrcoDGHs8882vb1xxD1npZDjw6ZeKz8F5o4WaZRl4vzKPoHF/Xa9HPAefOWmDNLjFF5CWUuWeCWalBSU1TNhnU7JMaOaaQxYKYPvCKDjKMOOY0eoQj0rty2hnUyomdM58mXr4vwQd2N64x40ye8/SA/MQgtTbeMkKF6RQbKMEbhgWXAkTPuJBbD1C5Z0lzxGzseAEIX7IEXN3NG7x4S3UJnYQ0Ovo/tDHmbXMq3KLchqlcEdYO253JElYEQpcOwQtHaANQjPiPitgJ/i04uFg6Z4PDvHzuh6d25h3gZH5ycwRaNx8maV1Iww+3Jn8QBKZ0QFDS0v0Q8ksRib56glIdanKpF8hCxQkR3EMEmOKp20CeoKpwRQLzWvMgpPbLSDA/9LDNVT4Oa+kYwS6qunl5Nzhmja8Ndo3WN7c3NLPUOF7ByLgDRR+e3NzeX4ncrZoQoMGflFUdljGYgvP+ByhXIH6SYsyFMbJ75C/Kpa3l1j+NYF9MKV+VSC3by6BzB2g/VzSX/ZBSPWqsXl3rWQe0LZDWmRLcE/g2L1zxr0aKESF/VCYyGEmVm2kgylP0KpPqo6W6uTIfknVI5E6OTGejx40dFc6bGNehGD9NEFdcpJKNOxhIk3ydDO55UQj3YBYkjcN4FmeGz3D0m0nxBE36vgbDicmu2v0jeOFMd0YN1daWitA5OCoVa9Onmf1ztq2ifE+V4baKAOLE/3dfxM7q2BAXw2BDgnrGHfSuDGXhfBxs5EZjZ/F/XLFZvMHtsGJdneMGg0iGVTPdRJqK0VksVKGoWHL0lrjKKnDdOz3+346OgUjjiUlSVBB8LirsaL+OgkSdixEQIrsGfvnYUUHlPnGkZjcUSynndA9ySuDnZ9Rdm+U/IbvgKZgAnwLiVVCxrEUI1u1XfOFepVmy7Q3zk/PBtwfzt+ud7AVCuo+VFBVqfDwyam6pm2E6uj9hMsn4aRIqQDoOSE9rbFvN0J5+EkY/1i0c+5P1nt1XPWl6whN7fAkVEn/cPkIh/4LJT41XmJ/+CJ5AYR+9Oo1ird9SRFpJN43dscr0nPScEGh5ENzg1jBhp/KrnssOf+4XKFw2r58dianO07sKZ34HdGaGIfIZ3Gv4krobRmJmDc6iUpoQg+Z6DEyUbsgr67G45yiGkfom9y6eqWqGp7Dqurkm6Nnb7Sh7aQpPWtE/QP/uRrt @@ -23,7 +23,7 @@ import Translate from "@docusaurus/Translate"; diff --git a/docs/bitrise-api/api-reference/sidebar.ts b/docs/bitrise-api/api-reference/sidebar.ts index b1973a79..46727dce 100644 --- a/docs/bitrise-api/api-reference/sidebar.ts +++ b/docs/bitrise-api/api-reference/sidebar.ts @@ -61,13 +61,13 @@ const sidebar: SidebarsConfig = { { type: "doc", id: "bitrise-api/api-reference/app-delete", - label: "Deletes an app", + label: "Delete an app", className: "api-method delete", }, { type: "doc", id: "bitrise-api/api-reference/app-update", - label: "Updates an app", + label: "Update an app", className: "api-method patch", }, { @@ -109,13 +109,13 @@ const sidebar: SidebarsConfig = { { type: "doc", id: "bitrise-api/api-reference/app-roles-query", - label: "Lists group roles for an app", + label: "List group roles for an app", className: "api-method get", }, { type: "doc", id: "bitrise-api/api-reference/app-roles-update", - label: "Replaces group roles for an app", + label: "Replace group roles for an app", className: "api-method put", }, { @@ -127,7 +127,7 @@ const sidebar: SidebarsConfig = { { type: "doc", id: "bitrise-api/api-reference/app-notifications", - label: "Updates the app's notification settings", + label: "Update the app's notification settings", className: "api-method patch", }, { @@ -157,7 +157,7 @@ const sidebar: SidebarsConfig = { { type: "doc", id: "bitrise-api/api-reference/app-config-create", - label: "Upload a new bitrise.yml for your application.", + label: "Upload a new bitrise.yml for your application", className: "api-method post", }, { @@ -397,19 +397,19 @@ const sidebar: SidebarsConfig = { { type: "doc", id: "bitrise-api/api-reference/cache-item-delete-all", - label: "Deletes all key-value cache items belonging to an app", + label: "Delete all key-value cache items belonging to an app", className: "api-method delete", }, { type: "doc", id: "bitrise-api/api-reference/cache-item-delete", - label: "Deletes a key-value cache item", + label: "Delete a key-value cache item", className: "api-method delete", }, { type: "doc", id: "bitrise-api/api-reference/cache-item-download", - label: "Gets the download URL of a key-value cache item", + label: "Get the download URL of a key-value cache item", className: "api-method get", }, ], @@ -529,13 +529,13 @@ const sidebar: SidebarsConfig = { { type: "doc", id: "bitrise-api/api-reference/pipeline-abort", - label: "Aborts a pipeline", + label: "Abort a pipeline", className: "api-method post", }, { type: "doc", id: "bitrise-api/api-reference/pipeline-rebuild", - label: "Rebuilds a pipeline", + label: "Rebuild a pipeline", className: "api-method post", }, { @@ -775,7 +775,7 @@ const sidebar: SidebarsConfig = { { type: "doc", id: "bitrise-api/api-reference/org-show", - label: "Get a specified organization.", + label: "Get a specified organization", className: "api-method get", }, { @@ -793,7 +793,7 @@ const sidebar: SidebarsConfig = { { type: "doc", id: "bitrise-api/api-reference/organization-group-add", - label: "Adds a group to the organization", + label: "Add a group to the organization", className: "api-method post", }, { @@ -805,7 +805,7 @@ const sidebar: SidebarsConfig = { { type: "doc", id: "bitrise-api/api-reference/member-add", - label: "Adds a member to the organization", + label: "Add a member to the organization", className: "api-method post", }, ], diff --git a/docs/bitrise-ci/getting-started/migrating-to-bitrise/migrating-from-app-center-to-bitrise.mdx b/docs/bitrise-ci/getting-started/migrating-to-bitrise/migrating-from-app-center-to-bitrise.mdx index 2c16d0a8..535fbc4b 100644 --- a/docs/bitrise-ci/getting-started/migrating-to-bitrise/migrating-from-app-center-to-bitrise.mdx +++ b/docs/bitrise-ci/getting-started/migrating-to-bitrise/migrating-from-app-center-to-bitrise.mdx @@ -117,4 +117,4 @@ The App Center Distribute service allows you to manage app distribution across m To get started, you just need to [connect an app](/en/release-management/getting-started-with-release-management/connecting-an-app). Once you successfully connected an app, you don't have to go through any of the online stores to manage your releases. -We also offer [a fully featured REST API](/en/release-management/release-management-api) to make the most of Release Management. +We also offer [a fully featured REST API](/en/release-management/api/release-management-api) to make the most of Release Management. diff --git a/docs/release-management-api/apps/api-reference/create-app.ParamsDetails.json b/docs/release-management-api/apps/api-reference/create-app.ParamsDetails.json new file mode 100644 index 00000000..9154effd --- /dev/null +++ b/docs/release-management-api/apps/api-reference/create-app.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/create-app.RequestSchema.json b/docs/release-management-api/apps/api-reference/create-app.RequestSchema.json new file mode 100644 index 00000000..b333cc33 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/create-app.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"An uuidV4 identifier for your new app"},"manual_connection":{"description":"If set to true it indicates a manual connection (bypassing using store api keys) and requires giving \"store_app_name\" as well. This can be especially useful for enterprise apps.","type":"boolean"},"platform":{"type":"string","description":"The mobile platform of your app","enum":["ios","android"]},"project_id":{"type":"string"},"store_app_id":{"description":"The store identifier for your app. \n- In case of iOS platform it is the bundle id. Check the [property description](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleidentifier).\n- In case of Android platform it is the package name. Check the [documentation](https://developer.android.com/build/configure-app-module#set_the_application_id).","type":"string"},"store_app_name":{"description":"If you have no active app store API keys added on Bitrise, you can decide to add your app manually by giving the app's name as well while indicating manual connection with the similarly named boolean flag.","type":"string"},"store_credential_id":{"description":"If you have credentials added on Bitrise, you can decide to select one for your app. \n- In case of iOS platform it will be an Apple API credential id.\n- In case of Android platform it will be a Google Service credential id.","type":"string"},"framework":{"description":"The framework used to build the app. Defaults to 'other' if not provided.","type":"string","enum":["flutter","react_native","kotlin_multiplatform","other","native_ios","native_android"]},"workspace_slug":{"type":"string"}},"required":["platform","store_app_id","workspace_slug"]}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/create-app.StatusCodes.json b/docs/release-management-api/apps/api-reference/create-app.StatusCodes.json new file mode 100644 index 00000000..867f495e --- /dev/null +++ b/docs/release-management-api/apps/api-reference/create-app.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"The created app with default framework","content":{"application/json":{"examples":{"201 - The created app":{"value":{"id":"50590a63-799c-4bc7-99e2-c3b2363b22d1","created_at":"2025-02-11T09:26:01.000Z","platform":"android","project_id":"23c9f973-6b65-4aca-945b-a6eb4a0a9913","workspace_slug":"workspace-slug","icon_id":null,"icon_url":null,"app_name":"My test app","current_user_release_management_admin":false,"framework":"react_native","latest_version":null,"latest_version_date":null,"latest_build_version":"","latest_build_version_code":"","license":"basic","store_app_id":"android.app.name","store_connected":true,"store_credential_id":null}},"201 - The manually created app":{"value":{"id":"50590a63-799c-4bc7-99e2-c3b2363b22d1","created_at":"2025-02-11T09:26:01.000Z","platform":"android","project_id":"23c9f973-6b65-4aca-945b-a6eb4a0a9913","workspace_slug":"workspace-slug","icon_id":null,"icon_url":null,"app_name":"Android App","current_user_release_management_admin":false,"framework":"react_native","latest_version":null,"latest_version_date":null,"latest_build_version":"","latest_build_version_code":"","license":"basic","store_app_id":"android.app.name","store_connected":false,"store_credential_id":null}},"201 - The created app with default framework":{"value":{"id":"50590a63-799c-4bc7-99e2-c3b2363b22d1","created_at":"2025-02-11T09:26:01.000Z","platform":"android","project_id":"23c9f973-6b65-4aca-945b-a6eb4a0a9913","workspace_slug":"workspace-slug","icon_id":null,"icon_url":null,"app_name":"My test app","current_user_release_management_admin":false,"framework":"other","latest_version":null,"latest_version_date":null,"latest_build_version":"","latest_build_version_code":"","license":"basic","store_app_id":"android.app.name","store_connected":true,"store_credential_id":null}}}}}},"400":{"description":"Parameter missing","content":{"application/json":{"examples":{"400 - Validation error":{"value":{"code":"ERR_INVALID_PLATFORM","message":"The given platform is invalid. Valid platforms are: \"ios\", \"android\""}},"400 - Invalid framework":{"value":{"code":"ERR_VALIDATION","message":"Validation failed: Framework is not included in the list","details":{"framework":["is not included in the list"]}}},"400 - Invalid store credential id":{"value":{"code":"ERR_INVALID_STORE_CREDENTIAL_ID","message":"The given store_credential_id is invalid."}},"400 - when parameters are missing with automatic connection":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: platform"}},"400 - when parameters are missing with manual connection":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: store_app_name"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"examples":{"422 - Unprocessable entity":{"value":{"code":"ERR_MISSING_DATA","message":"You need an active store connection for connecting your app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/create-app.api.mdx b/docs/release-management-api/apps/api-reference/create-app.api.mdx new file mode 100644 index 00000000..97983a6d --- /dev/null +++ b/docs/release-management-api/apps/api-reference/create-app.api.mdx @@ -0,0 +1,69 @@ +--- +id: create-app +title: "Create an app" +description: "Creates an app for the workspace." +sidebar_label: "Create an app" +hide_title: true +hide_table_of_contents: true +api: eJztWdtu20gS/ZUGFwNPAt0sXwIZkxloEicrrC+BrBiYiQ2iRbakHlNsbrNpR2vodT5gP3G/ZE918yJKtCcGFlgsZv0gi2R3dV1OnaqiHr1QpIGWiZEq9k68d1pwI1LGY8aThM2UZmYh2IPSd2nCA9HxWp5KhOa0fhSWO4ZJgiepCDItzco7+fLoGXUnIPLL7fq25Rk+T/Hdw7rUw3XCNV8KIzTdxbUWaaLiVODy0ev39ulfXbMJ1AjsWaFV7UGaBQvFjGeRYTOSRkpCiUDFRsSGJGBdJAOra/e3lMQ8euIrXyZReRBrsy3J9OCeR5mgL5JMPOodDXr8+KD9ZjAI2ofT4E17MBD9dnAw7R8c46Mf7tPBTobPcTZE94/avX57f3/SG5z0j096+51er/cr1iURN3DsEqt4HGqFM3BTq99EYHx7YP8gGMwGbw7ax9Pjo/YhD3h7cHg0bfNjMT3kPT4Y7B9gTxkVP42yOfaVN9r2RsuTcIYVGWdRlF9mOiquYa0fw3PYer5iiLuxDoApmdbwoZ+lQvtaRIKnwl/ymM/Fku7zcCnhzRmPUtHyKu+fIJAcVsTw+b2AoIjQZPx7BNqG0Z1bv+uHuNx6NM1kFFbbPK/5iR+oUOSPZSAAIFxMeSoDQqNRWvhko3Vq7usObnSs0cUKOCWG6wUWGZ2J8rYWIWyVPCo9uF63NjADf2Q8ilb/B8/QacKGf2rw5AZ9I3q+gcv+lFj6TxGRQt3S/3sg+kMGor+Wd9jr7ZbIT0VRZUuZpjKev6waQiawec0jGdpFTGitdA2FubGn47E/urgeno3e+5/OhpMPl+NznLUUaYrA5MV6jiSOWYExJlMm43sS3nFnlI/QbWhxwm48qdIbr4UvuaNuPC+3FXqN3OYn0mNDMavWcDK6vKiptGHXjMtIhCfsQyGKlIuVgYJBlIVIShnbtieSqYGQUBjssD7aOP2L99yu2/Wu6jaqrIoqo6g+792ryeX41H83Pn1/ejEZDc/80fsnHN0AmU2fb3jyYUFxKRsw8n4BGMdEPDNqCVcFLAemdGBpUvTTcDw8P52cjv3z0dXV6OJjTT17CqlRyM/7SSuJ7otlYlZ0N9fzpETFSxR2lfi/oW2V4Tahq/Rs6GA/x3DsQmn5DxG+NDOpatT2P2Hg54vh58lfL8ejX0/rQKltrtQ8aGARoa39SBRASb5c1wPouivkqYicjm0oLi98QHy0pfWumFL1fr/Jw6heAe2eRoJRHmAWeZn2/b71dIOcJwzIgeSDcoY13X9RGYsFVXjMUgG1NAUBlDC181VxCbytVKap8HVKM4+aeH4Ec3QMwF8JjTLETi1Pv8jOo5yYmgQ9SUnIm4vhWc3IK4WcXNhExMnsQStUnXWhvRZ/z1Axf1bhygl7Vr80WIglp29mlZBwNaVOxPUkmDmNdLo71szXpEa7Qld30TBmWSbD60NwLMVvJmEeedu6OBYPtr+Aio46/Dp1bLl7xlJhmFGMijOTxPghKU9z8i73sO+nq4Q7Asnspws7TyS7E6v0FQARMnKNxNRL7E1rbrw6ldx4jKdwahR10C6CewLAaAowpokIpB070BPNsshaJSiQiZYpHZOkNKXn/pkqhaYpJlOrdu+PvGenGzVFlazqt5qV8MR6EWdLWwJViquie7xd1/vH7XPW2y1R05DvvNUUNsoMdhMTbuEO2Aqd5OXVRo9hiKWJsqdZHEYkpcPeLURwZ29+yXG0Yhun3n6/MCZJT7rdUNyLiBZQgxaJTqCW3VAFGTWaDqlOKqIGbUAPXRnTsfaZX8j2qfx3g5lbW5nxqrOleTE0NWiPzvkO+cUICDUDauo0ap63mKS77VO7AOZMzjMt2rCqvVRhFom/AM8+BPobaYh4vNrATVPEXIfekB6IDltwEFysCqqjscZFcvhpZHHPeEhNEhLkZ2kIqi27j3AdAtKhoAzDmjLW1YA9XRVpQl7Ao73U+qZIEXQIhNU8LWndblbaRoG2p3IpI64hlkSELM8QNov4/BkHbDXjz3mhWvptRqeYawKDReJlWH+QMB2cAGFDQqx1da29/BbMlVLYR6XmkELFAKPMlqQmz9R68d1MLh8TVYVkqYVkEcQOe+9G3pQe7dmBbY/JmW2qkU73cE/DuRX5zKLMGDvkbb04uFMmkrG/hGxZsl6rHAndOt9xV36xSWHb4+wOjeWlDfwdkh4bR9TobUfSrSuLVDIVDYSJsvNFws0CV137BpUKcWpfoNr52HvEMCk+j8/W3Xz8bVfjb/e+3yW+797T2H/PtaSGxRbJfJcLjPUyZBV8gVLUmTo8dqRqpH+nCCMxDHI20oeqtLAdym31xvfK3rUn5+99S6fhsL8JasNoUPcWgoc2CFtN53CCqmxbLr0iOAAxDs4gABcm+3agaGItZdlAUPcwrvqMU9fklK9MStA0FHo3a2+8BXGIqL0BKfdvzfIN93MVt55s8Ub1ePNlRYXknVcpVbZRtbF+lYYM9MYOD+y8xAN5jIBQvrS473f2d3z9+vWZUnfEksXrfYWkxNafXr9mv+TsNAOZEjsgYzCb/8DZQovZ270mECLAbRQmKoeh+NpZmGX0E7CbdtCQLBHOC9j5Nlf2u36vUhcXOBWf1/v4eA8Re8xwPRfm7Z4/jXh8t/fj9b6FAXU9P3T5jzfxTTypNC7JKxSJFoF9oQau/SCmOiMg7aeG9Xv9Nx046Q7YRRmEwdxUXL2Uc223UXsHwdQakuCpmCm7WMQdOvRZDzgh8G57jqZTWBc0mCIhm86ATf/6/Z/sus/Oi43sI20kC22nBl6AeAp2Dqr67zLbId1orb/pF5w8M434arqAv7TtoaWbx5yMvnj0K82C+AnfHx0J6Wi9pttINr1yv9sUnGN/52kV2U3shZJP2ji92hM6sVXMFbvt/7pV7BgGgUjMs2tvNyj00+XVBIun+YixdPOK5g9UFfBp38wp6yfLTvbeo4eIzDM3wjiZRCVELnXiurPElX+xP2rlj+LVpoY1UmrlhtAnmdW45fHR0SIcWqx3j57cURKnW00xo3Lyb0Nok/4= +sidebar_class_name: "post api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Creates an app for the workspace. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/create-custom-access-link.ParamsDetails.json b/docs/release-management-api/apps/api-reference/create-custom-access-link.ParamsDetails.json new file mode 100644 index 00000000..67ea0d9f --- /dev/null +++ b/docs/release-management-api/apps/api-reference/create-custom-access-link.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"installable_artifact_id","in":"path","required":true,"description":"The uuidV4 identifier of the installable artifact.","schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/create-custom-access-link.RequestSchema.json b/docs/release-management-api/apps/api-reference/create-custom-access-link.RequestSchema.json new file mode 100644 index 00000000..069aaf63 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/create-custom-access-link.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"A human-readable label for the access link. Defaults to the tester group name when tester_group_id is provided."},"expires_at":{"type":"string","description":"ISO 8601 datetime string after which the link will no longer be accessible. Omit for a non-expiring link."},"access_code":{"type":"string","description":"Optional access code (8–64 characters) required to unlock the install page."},"tester_group_id":{"type":"string","description":"Optional ID of an external tester group to notify with this link after creation."}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/create-custom-access-link.StatusCodes.json b/docs/release-management-api/apps/api-reference/create-custom-access-link.StatusCodes.json new file mode 100644 index 00000000..6d33114f --- /dev/null +++ b/docs/release-management-api/apps/api-reference/create-custom-access-link.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Creates link and notifies an external tester group","content":{"application/json":{"examples":{"201 - The created custom access link":{"value":{"id":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee","name":"QA release link","created_at":"2025-02-11T09:26:01.000Z","expires_at":null,"url":"https://app.bitrise.io/app-install/example-token","creator_email":"default-user@example.com","creator_name":"default-user","creator_avatar":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"}},"201 - Creates link and notifies an external tester group":{"value":{"id":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee","name":"Beta testers link","created_at":"2025-02-11T09:26:01.000Z","expires_at":null,"url":"https://app.bitrise.io/app-install/example-token","creator_email":"default-user@example.com","creator_name":"default-user","creator_avatar":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"}}}}}},"400":{"description":"Artifact is not distribution-ready","content":{"application/json":{"examples":{"400 - Expiry date is invalid":{"value":{"code":"ERR_VALIDATION","message":"ArgumentError","details":{"expires_at":"Expiry date must be a valid ISO8601 date-time."}}},"400 - Access code is invalid":{"value":{"code":"ERR_VALIDATION","message":"ReleaseManagement::ErrorHandling::ValidationError","details":{"access_code":"Access code must be between 8 and 64 characters."}}},"400 - Tester group is not external":{"value":{"code":"ERR_VALIDATION","message":"Only external tester groups can be notified via an access link"}},"400 - Artifact is not distribution-ready":{"value":{"code":"ERR_VALIDATION","message":"The provided artifact cannot be used for tester group notifications, id: `5738cc8d-8b88-4791-b023-13f7023def3f`"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to create a custom access link. Only Admins, Owners and Workspace Admins can create custom access links."}}}}}},"404":{"description":"Installable artifact not found","content":{"application/json":{"examples":{"404 - Installable artifact not found":{"value":{"code":"ERR_NOT_FOUND","message":"The installable artifact cannot be found."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/create-custom-access-link.api.mdx b/docs/release-management-api/apps/api-reference/create-custom-access-link.api.mdx new file mode 100644 index 00000000..2282fa29 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/create-custom-access-link.api.mdx @@ -0,0 +1,69 @@ +--- +id: create-custom-access-link +title: "Create a custom access link for an installable artifact" +description: "Creates a shareable custom access link for the given installable artifact." +sidebar_label: "Create a custom access link for an installable artifact" +hide_title: true +hide_table_of_contents: true +api: eJztWNty48QW/ZUuVVEDU5FvycwEFwOYSTi4yMTBcUIdhpRpS22rsW6nW7LHuFzFEx8Af8iXsHa3ZMuxTcpzeMQPtix17732be3dWjq+0J6SaSaT2Gk7b5TgmdCMMx1wXI9CwbxcZ0nEuOcJrVko4ykbJ4plgWATORMxk7HOeBiaxVxlcsy9rOacOEkqFCfBXX8t+o0R1jGyriAKy7TwciWzhdN+t3SyZCoA5N3D6uHEyfhE49rpVhR0CgXawYKUKx6JTChtNsf4A00VPMMSz1D6UCXJxpRnAa6V+F8ulQC0TOXi5JEjBrAuz6V/f8akL2IIkUKxZGzMPmSw9gIRcacNMxYpIdGZkvHEWZExSug0ibXQ9LzVaNLPfucbF/PYZ3Fi9CIcMRPvYWbMQ4YVuGITleQpdHpJnAEfSeNpGkrPeLz+syaRS0e851EarpUyl5FlntHk7wktrZvxMBd0ISluvPi4I3xcDx/Xx8cVlQ9wFL7/rsOUCAXXwooDQKtryIEREFov3EbLbTYHjU/brZftRrPWaDR+wDrxPkU4tFkX52F44uQqxJYgy1LdrtdhXW0k4VAtajKhv24Rh3phpGuTp1CZqCGCIUmEL8Y8DzM310J9WSyueUlUWVrAr66sPOUznnFVAVMAcdN8BJe7RRDcVCV+7lEAavq0xiP+SxLzuSZddRLpSqzUdSvOLZTVUpMiJ0V8PiAL/s+YfSUyXgjU/0btuKjR58Q5azR2y7lkKiY1xZD5kuhglNNjFxD9xXHlCyVIj0ty+IL5iA4JljEiTzGvpICX+OSVy35/eN+56l50Bt3eNXRFKHI+EQbaJI+g9lKphDzmIwNkqK3GTUCdqrIIXMFGIDxmNLLube/8JTKWHrqZjETNKX0BmJbhGUH5cJh9yyRveYz/hLfdNoi/QVkgTyft9j1JNS7bY4qltWGhp4qotGUksrlABzs3hfbyjHnoeggZCmHLmkGl2spwlqV4pE29OFzsL2NgQ4UDVVHwPptJTkVfpeeKh59Or+OQUWNAKczQ7/x1WyNMJB2wUAq+7fxVb1iwNm31CZplm/304tXpueed++756PzcPXv1adMdNVqnbvN0/Aq/qKDT8U+V4tnTC+9inmdBouQvwj+2TIhFt/Yf8MPddedu8E2v3/3h8mLLE1ubNzBPd2HeCBVJrfGHYUqQx2M9BdZdIQcA31z233ZvbxG44cXldfcR6v8mOQv4jPKHpWuRmmVJ0e9RursNv8ZMRnb8SFL8evOYugCVw/eJmuqUe6J4aNKzkLQrxxZM4amzXU9198xMJm/HSR4f7bYzuO0JiQd8eN0bDL/u3V1f7OT+vqmukv5G6sbIF/sovxsXdX0r1AwlUpLSEba9MMW9X9ABk7rXg8v+dedqy6LbBINxAJJkc2hmc5Ws+9XKDr+o4q8SyxJP4NuZa5PRz8LLoA98gVTLpMVu2/Hj6ffxaN1hQR5xy1HG2XC5CNdniq3cvLDN1iQxPdymHqhj8wD8bW8PzW1M+kSJJZMhYttTylPw0NfYurFRX2N2IeNjUj0PpBcYLGZAm8swpIIL4V48HZX4JQxDaUUyM4ZxrIldA4NEGeMI2FaLegpZz1wgKXillX18/uevf2x1rk9YebQhr+VxmHjT6rGFpcgQo/2R245A0L2gs9ChgZT0mr6wgH8y8pYs51njQ0MiNG6tq4lyNaHJNU20ySs6o7WdeqUm3bImdX154IS3qltecq2DXMNL5oRJRWTPiHY8XY4wV9z1r1b14rTiRushoz5r0Zyq67Mm9s64kqTHJHixyxa+ycytUVdWRt0d3xHFWCCMxDDIKb2DB1RhdoJ62JyIb81do7k4F68DBGXfikV5pA1QSkLtqLzpDFgsyBUcUxwlA/R2brpgtTDUmwNA2e1MUMyIQZXf33DEpSWoTY1vEmRrXlzf3R691rd3Em59QiZDxokxUGZhZfhjm+mPoFNEEEpr36xVa+4Y/fz5VZJMqcpKRklCn7Z+8fw5ox5JbWws0eBQm4FQos0+4yxQYvz62b5sgKddP/E0ctEX72tBFoVfIIl0LVUygl+v4ZDXBdiPWo0NXPyBVnzfN/F1ARHPGA4QE5G9fjYchTyePvv8vmnioVPhfVbnn/8Y/xgPNogtu4BTfJEq4ZkjO4aEr8VI5RTRJqZYnM1e1eCkKZIoV2DIgGdsUY4CkZwos63gz1jMjeCRgHNosYhrpPRvPWCF0Fg5yUGpxgV7TJGQTTpg05+//c7uW+xtuZH9hzaShRRpqnGIr2TT5rXTgZdNfP9bpsfBr3Syf/ZVVlF1GeiunoYcRbcqTrrLgqveOXu5Cnvbh99H7aMr1H9AJAiJS0tTKlyt6DbKUdFbsocNKxlKw+RP1yinMQ/141dZVZ983C86wyfsg15w7XVDyUjxwtClmU8cXE7BT4dfxq0esLXgLTLCrn5THMkHJHMjbWcoWZ2UO+hYl2Z/u/ah0l9uercDLB4Vg09kCUrxOb0RxLdBnhjXGd4195YOUnyS28HKyiSSJNrcpuSpoeTiwrzO3OebbbotHUXfZNbeLculJXwkQrnePjq4Y90SyjCQx1ervwC22p4K +sidebar_class_name: "post api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Creates a shareable custom access link for the given installable artifact. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/create-draft-version.ParamsDetails.json b/docs/release-management-api/apps/api-reference/create-draft-version.ParamsDetails.json new file mode 100644 index 00000000..9154effd --- /dev/null +++ b/docs/release-management-api/apps/api-reference/create-draft-version.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/create-draft-version.RequestSchema.json b/docs/release-management-api/apps/api-reference/create-draft-version.RequestSchema.json new file mode 100644 index 00000000..09a1a445 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/create-draft-version.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"app_id":{"type":"string","description":"The uuidV4 identifier of the app."},"version_string":{"type":"string","example":"1.2.3"}},"required":["app_id","version_string"]}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/create-draft-version.StatusCodes.json b/docs/release-management-api/apps/api-reference/create-draft-version.StatusCodes.json new file mode 100644 index 00000000..8c5df2fb --- /dev/null +++ b/docs/release-management-api/apps/api-reference/create-draft-version.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Creates a version for review","content":{"application/json":{"examples":{"200 - Creates a version for review":{"value":null}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/create-draft-version.api.mdx b/docs/release-management-api/apps/api-reference/create-draft-version.api.mdx new file mode 100644 index 00000000..3449a3bd --- /dev/null +++ b/docs/release-management-api/apps/api-reference/create-draft-version.api.mdx @@ -0,0 +1,69 @@ +--- +id: create-draft-version +title: "Create an App Store review version" +description: "Creates an App Store version with the specified version_string, which can be used to submit for App Store review. - iOS only" +sidebar_label: "Create an App Store review version" +hide_title: true +hide_table_of_contents: true +api: eJzFVttuIkcQ/ZXWSJEli4thdxXJWu+KrEmCYmMHsKXEa6GGKZheD9Oz3T1ggvyaD8gn5ktyqmeGi8GW/BQehrl0VZ06VXW6V0FIdmxU6pROgtPgiyHpyAqZiFaair7ThsScjMVnsVAuEi4iYVMaq4misPw0tM6oZFoRi0iNIzGG+YhEZrHCaWGz0Uw5MdFmy6mhuaJFTVSFuuoLncTLoBLolIxkKJ1wDebcyIm7zeNgiaVxZpRbBqd3q8DpBwLsu/un+0rg5NTiPkCMmDaRAnxKpZEzcnDCiyuBIZvqxBIeV0Hz5IT/XiBinT3Dz0EDxVgnjhLHdhLh1Nijrn+zbLwK6FHOAKJ0jyRf9YdVcxlnFJwmWRw/8a8SvD9p7MO6SWTmIm3UXxS+DQbcAcaO/SbsCp5C/AftXm94023dDH696nX+bJ8jxoyslVN6HvxpDfPdPsxrMjNlfZohJertWN8B676TFwBft3uXnX6/c9Udnre7nWeo992soTea+9D7TiahNKEAQkKLoEbfM2XenEKjiRRedvZCKv1Bq3ve6p0PLzpf2t1+e9hr/37T6T1LaRApiwFLaIKxKlxya+2F4x7jgQXwhMYO4wjctTUBHw51fgc5mkTGok8GvSraxmjztuQ/+JY/7OiFxDvdQbvXbV3s5NnXGNoIwiIWiCwWRifTAvwTD/H3jKz7SYfL3Nmr+Ow4opnkO7dM2bkefQMliJcalh2ncuywHapwa10ubVi3S9MAtGaZCm/fC4W+cqyHRuiJ5ztnuRLsyuMhpwVteNWoNWvvgjKxvEnuSjh7ru5zDpgfzVqZautzkS7CU50ZoCquVcsayM/VwoP1IsoVsV5DMxPDYjWSlm56F091QzHhvjqTCaowQ2r1eZMd2Pq8wUCkUXJUVLqwyrtoIrMY/AeRc6k9rcNG1UYKeC3VlD7IYA5EsBsBP1tbDJeLfKveb0S/79/6yIX0rxlFsN+I9xDFviOSIZm9kNetgcAgcIOZJW9N2KJE67qDHSuOmZgE2wQ7K3TOt5CvCbdRb9Nw7bJsm4bZ1PR51cvSMraJ9piV8zXv5VyLyzXXjGbjAkvmzVpjL4/j4wutH3gwygnXccimn4+PxR868zvwRCWhgEBEZOhUfJQiMjQ5OzpUYJBXDfXY1mFCj7XIzeLP6AtbS42agaouaDkrwP7QPNnAxQOi4nrbwOUcLo6Ek2ZK7uxoOIpl8nD06bbhKeZDw8e6/PQ1+ZoMNohR8jjm00JIqSEMLUQKUv0zjUzGRWpYJ5onzR9rIOkBfZHh7OAi6cQSaUZyTmKmpsaboZ5MRUIL73hEE+0XU1LjoK8ykDsBu9Uphpo8BQdSwW7tYyCnf//+R9w2xWVpKH5hQ86QK83zCPdc7KKnDh6t8gNAeSZ4XuctUfu/T2bFlDl6dPU0lhgyJOmlY1WIjteqbdGB1Y7sYI4jVimsXOVyY3DW4dcYK7PMT2aluvhDXaWcY9apB0w3aMgJqQ4YT6XcSvYV/6lSWrTGY0rdq2vvt4T0+qo/wOJRsavM8i3KSD718fU08OdU51PCAv9uFaA/plm+a+U+WTRYRnYl6sFLVHHjT7DFp2S5jXBHfipFInzltA6arFa5AILQcn3+6UWLtUTmq7mivKn8B/SBJ9E= +sidebar_class_name: "post api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Creates an App Store version with the specified version_string, which can be used to submit for App Store review. - iOS only + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/create-preset.ParamsDetails.json b/docs/release-management-api/apps/api-reference/create-preset.ParamsDetails.json new file mode 100644 index 00000000..9154effd --- /dev/null +++ b/docs/release-management-api/apps/api-reference/create-preset.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/create-preset.RequestSchema.json b/docs/release-management-api/apps/api-reference/create-preset.RequestSchema.json new file mode 100644 index 00000000..dd3cca18 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/create-preset.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"app_id":{"type":"string","description":"The uuidV4 identifier of the app."},"default":{"type":"boolean","description":"If set to true, this preset will be used as the default template for the app."},"release_candidate":{"type":"object","properties":{"source":{"type":"string","enum":["ci","api"]},"branch":{"type":"string"},"workflow":{"type":"string"},"auto_select":{"type":"boolean"}}},"auto_upload":{"type":"boolean","description":"If set to true, Release Management will upload all successful builds that ran on the given branch with the given workflow to the App Store."},"notifications":{"type":"object","properties":{"slack_webhook_url":{"type":"string","deprecated":true,"description":"You can get notifications about release updates on Slack by setting this value. Make sure to send the properly formatted webhook url. Regex for validation: ^https:\\/\\/.*\\.slack\\.com\\/services\\/T[a-zA-Z0-9]*\\/B[a-zA-Z0-9]*\\/[a-zA-Z0-9]*$"},"slack_notification_integration_id":{"type":"string","description":"You can get notifications about release updates on Slack by setting this value. Make sure to send the an integration ID found in Workspace Settings."},"teams_webhook_url":{"type":"string","description":"You can get notifications about release updates on Teams by setting this value. Make sure to send the properly formatted webhook url. Regex for validation: ^https:\\/\\/(?:.*\\.webhook|outlook)\\.office(?:365)?\\.com\\/webhookb2\\/.*"}}},"approvals":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"summary":{"type":"string"}}},"description":"Tasks for the approval stage. Sending this value will replace the possibly already existing approval task list."},"automation":{"type":"array","items":{"type":"object","properties":{"event_name":{"enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed"],"type":"string"},"workflow_name":{"type":"string"},"pipeline_name":{"type":"string"}}},"description":"Automation events (workflow or pipeline runs) setup for specific event types. Sending this value will replace the possibly already existing automation list."},"outgoing_webhooks":{"type":"array","items":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed","app_store_release_cancelled","app_store_release_completed","app_store_release_started","app_store_review_approved","app_store_review_cancelled","app_store_review_rejected","app_store_review_submitted","app_store_version_created","app_store_version_updated","app_version_added","approval_task_added","approval_task_changed","approval_task_completed","approval_task_deleted","approval_task_reopened","approval_tasks_completed","auto-upload_disabled","auto-upload_enabled","automation_added","automation_removed","google_play_automated_rollout_cancelled","google_play_automated_rollout_configured","google_play_automated_rollout_paused","google_play_automated_rollout_resumed","google_play_release_completed","google_play_release_notes_localization_added","google_play_release_notes_localization_changed","google_play_release_notes_localization_removed","google_play_release_started","google_play_rollout_percentage_changed","google_play_testing_track_release_completed","google_play_testing_track_release_failed","google_play_upload_completed","google_play_upload_failed","google_play_upload_started","metadata_localization_added","metadata_localization_changed","metadata_localization_removed","microsoft_teams_connection_changed","outgoing_webhook_added","outgoing_webhook_deleted","outgoing_webhook_updated","phased_release_disabled","phased_release_enabled","phased_release_paused","phased_release_resumed","release_candidate_auto_select_latest_build_disabled","release_candidate_auto_select_latest_build_enabled","release_candidate_build_selected","release_candidate_source_changed","release_description_changed","release_settings_changed","slack_connection_changed","stopped_managing_release","testflight_app_review_approved","testflight_app_review_rejected","testflight_app_review_submitted","testflight_distribution_start_failed","testflight_distribution_started","testflight_distribution_stopped","testflight_processing_completed","testflight_processing_failed","testflight_upload_completed","testflight_upload_failed","testflight_upload_started","testflight_what_to_test_added","testflight_what_to_test_changed","testflight_what_to_test_deleted"]},"description":"A list of event names that will trigger this webhook. These events correspond to specific actions or states in the release process."},"all_events":{"type":"boolean","description":"Indicates whether this webhook should be triggered for all events. Set to true to enable the webhook for every event."},"webhook_configuration_id":{"type":"string","description":"The unique identifier of the webhook, that can be found in the workspace integration settings. This ID links the webhook to the workspace."}}},"description":"COMING SOON. A collection of outgoing webhooks configured to trigger for specific event types. Each webhook can be associated with one or more events or set to trigger for all events."},"template_name":{"type":"string","description":"The name of the preset template."}},"required":["app_id","template_name"]}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/create-preset.StatusCodes.json b/docs/release-management-api/apps/api-reference/create-preset.StatusCodes.json new file mode 100644 index 00000000..abed7587 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/create-preset.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Presets","content":{"application/json":{"examples":{"200 - Presets":{"value":{"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","id":"921db057-73eb-418a-b7ed-04f451e9dd85","template_name":"Modified Preset Template","default":false,"description":"","auto_upload":false,"approvals":[{"summary":"qa-check","description":"Modified - After quality assurance has finished testing, check back here."},{"summary":"security-check","description":"Modified - Everything is adhering to our security policies."}],"notifications":{"teams_webhook_url":"https://outlook.office.com/webhookb2/modified","slack_notification_integration_id":"ceec9565-0de0-4603-92b2-255e42c2d203"},"automation":[{"event_name":"release_candidate_set","workflow_name":"modified-google-ser-cred-test"},{"event_name":"approvals_completed","pipeline_name":"modified-notify-stakeholders"}],"release_notes":null,"default_release_method":null,"app_store_release_type":"MANUAL","outgoing_webhooks":[{"all_events":true,"webhook_configuration_id":"88db186d-4776-4e32-aab3-1a7f93919171"},{"all_events":false,"events":["approvals_completed","release_candidate_set"],"webhook_configuration_id":"1591e3b6-fefe-47bc-a64d-c6fda12a3db5"}],"release_candidate":{"branch":"modified-main","workflow":"modified-build-app","source":"ci","auto_select":true}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"examples":{"400 - Bad request":{"value":{"code":"ERR_VALIDATION","message":"ProductPlatform::Service::Error::NotFound"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"409":{"description":"Conflict","content":{"application/json":{"examples":{"409 - Conflict":{"value":{"code":"ERR_DUPLICATED_AUTOMATION_PIPELINE_PAIR","message":"automation already exists: [{\"event_name\":\"release_candidate_set\",\"workflow_name\":\"workflow_1\"},{\"event_name\":\"release_candidate_set\",\"workflow_name\":\"workflow_1\"}]"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/create-preset.api.mdx b/docs/release-management-api/apps/api-reference/create-preset.api.mdx new file mode 100644 index 00000000..fb07b6c1 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/create-preset.api.mdx @@ -0,0 +1,69 @@ +--- +id: create-preset +title: "Create a preset template" +description: "Creates a preset template for the app." +sidebar_label: "Create a preset template" +hide_title: true +hide_table_of_contents: true +api: eJztWv1y27gRfxWMpp3cZUzJkmU70txdRhfrrpomtmvL6fRslwOSkMQzRTAEacfn+t8+QB+xT9LfAvwUKcfuXdt/msnIErBY7Dd2F3joeEK5sR8lvgw74867WPBEKMZZFAslEpaIdRRgiC1kzJKVYDyKup2djoxEzGnRzCuWneolmFTCTWM/ue+MLx86ibwRQH15/Xi900n4UuF7x4CqDoYiHvO1SERME/iNmUiGSuDnQ2ewu0t/6kTmi3c6rgwTESYEAroC39Uk9X5WBPfQEZ85qC8wMYvlSzFwy4NU0BcgCYWbCM8GDtsnfhZ7nrvYHQ2t4UjsWsOFM7KcA2doue5gcDhaDJw9T2B7DTsa9D1nd//QOtwTjjXsv+GWcyg8a3e4GO73xcjz3uwDNhekHYJbLPsgPX/hCy8jic2zeYB6YsHTAFwteKDEzgb3AOBpIu00CiT3CiDQHkvwpLTQVbpe8xgK6HzilrsS7k1nE09BgMUmC4iffUp5AKUxrlQa89AVbMUVW/ihr1YAg1kkfrjcYRodczg+ViIW3c7jTnXDXPlf3nZ6K+L7ZAWkzIfJecBG3xPJZBqzHA+LJBTrC4WNYB6hTLDeKFrrMRF8rew74aykvLHTOMAmqySJ1LjXk2kSYLQrF1giuq5c9zJAZ9BbZ5SQwQbgxq6itn1Y1jLOvpOeXSHc0f7BvrXrkU0c7O5Zo4EzsAb7+2I4cAfeYHcPotDKWXPDLTQhbmGgudJjEQiuhO3y0PM9sgbjMHcyvlkE8i6Hy0mzllIuA2EpEVtujN+kBC3vGtpC9zY4hMEnmqnIj0Tgh6KBVPN5b6mE34iVDDxyvUfteYY6zJPPhGkQFMZo55Nw1ZX08lnyGJXIWBTzyX2kzXtyfDF5T4EiTZYSas01ZOyTB4GtWcDPJE5hv7kC4Y0Lf5lWJf/mjef03xx41vDw8MAair2BxbmzZ/X54WK0N+qP+od9LZQq1swt8p+XW4TUrpHrJ+np74/6Ys85sBZiIUCU41r8YOhZ7sHC4/0B3/Oc/ZpAC+Rkrw751qqqjzX3w4oRVKec1A88C6STkcIrXJKt6+cxQGEDNzEifDT/djrDtpj5PfdYLD6lZD8viptDHTery+ux0yOKpmdn9sfJ+9nRZD47OcYGa6EUXwodrKWXuskpYhuOkPV4fC7iWzjjeDyNYxmPx8cy+UGmodcp6e836b8IwfBKxv4vWm0vYqAPBmrrt3BwcTy5mP/h5Gz20/SoxkNtcUnmXsvRJOK1rxR+ME+E/stp3aNDqoFkC8Gn07MPs/NziNw+mh7PNqhuoilJHzVJfwdDB3EvNo8RKC7WbiH06OL0/ezdZD49siHikw/aTOzT2en0/ex4ap9OZmc10ssYyniA3MK7Z+KzrxI1ZpcPV5Xgd9UZX7X78FVn56oeVzVsMdK/opDx2+G6LqXbHzSle54AIY89BjEJZDfam/z4xQbSH0Dc25Ftkf/5fHJ8NDk7sqGF6fH51D6b/ulidrZhMPMVjmFHhGLhJzlKSgUb2+W5YJE5mawwF8B+WwCagcc45AEj/0e2ob3/Zczv61DUjmgL47Pj+fTsWB9EJZ/nkg4xSjXusDO7i2W47BThMwtz30vvPssOn6JPIctZc52HmINPOj8L7UQ4bZAjJ76hPU8tCziVULLTSI/mEGua+t7HIfPhtZSQgEe5KHPvx0qCWGBzpITdhg10swXTWbxk+pQFFqg4S+3v/CCAulmqSIFK75Bh3pL2P2450p5mPT+3mqyLMF3T0WwOtMjvXGOH/HzcBH+snpAtk7UDsSEYrdpa3vxi2Z0Z1tkHHsKO1tp0SIQGIQJVwFTqujCzRQrB0slNQuXwJR4yhDKS49JHvGGGRyxPVpXRnD29JUYnUQTfkybFbkl8n5a6TmlraXGb7cEWgJIih0nD6iL4i0wZNM2WkENtf8YdJHYsswaIwNNlI5g8p32Zc0+yS3Q6TyanfbML0d0ICCkWxKISoaf5NIQH92RsiPoUTzK6GejuQvBL8VlbItCQ0YGCMfurSfKvrnr43319ddXVLOMv8jsMKZNnKHydX3Lrl4n10641ugZg7/uN39WfvyNZP6Me+JIj/3dEhw0qhLHZEcSEXAqD7M+wJhVxlHHnBp3SZtRSLv0HWJnTLv91K/jq7VgbQrbub1n59zWGTAUIgL2D/a/fFkZSVIPahrIoUVbShWR4HPN7qvgRGJ/hfDX5tcSqolpuzD0+Nk4Erm5UNQ5r4hiqtyVkeQ7x1eVrglIsEL+hey1ZiSzQgWRruRStKrAl2ATHu0q6myXsvyuCaoH6UET6bQUw1bXIIJerJIvPdt53wKQpgm0wdJ8Vm00YRyQcNeitL+5sw1VjOBY/62SlUvVBqgQN5GUhm/U57GUs06gCC79vEpIDJzHXvY72IlOlztoni9YbGnI0Zk2XS72WIMgI00NQbpICx4qHyxrBmIjrLEDkSMrIGFrASyKo97btOC201IDYaCE8w1onZeZuSm/2VXGswYRzhCxOQ/U1RYc00ratIuFSYDGrGO2jfrV1l7QUpt3SjvhVFv6c9Y185/9e8D/ygraGVXXjltkn15aEVOc2xd+Y27blpoIac4UIa5OogqjKt13dhW+fM2dzPpePcs/Lx7TCbDoHtoyWct0Yr0uoMuOJ9vFYwI3C5kTdXMh7rczEPV9xJ2gMi7A6aly9pL4cisU6U0XVdjMA2GMsgwCBoaaXL0BmXcFngEacCqwvgqEmS9cNuDYzbJvXLVs7kC5So1/qcngmeKneZy5oF2rTM2qzuUza3LUKWIsoX5RCO/SC+01VZpazDVMeUp9YWnK2RliFV/F2ubfPluy2z5dSXftuLJVcJLZJ2bNmSx3J5nFW7N6YKJ2xMVXGhmgFwXmFBCtutzFTet7GRGHtG+OleTcPv0rlblPTQSW2rp6r+79gVUlbc5GBMKu29f91u6LlGKkkOm1nUlZkVaZMFdmqNwTnKIJ41tRLIF1kaOpJAIXq5nHSDlA5NtoBqmdHBQIyRnripJpAbdul9T8J9gUIzV8dAhxQd4TYrfpfO0QbES3O25IybV/YSvfdisPFpA4ihftsmy81uA0i97PrZmqss1Dq5Zkcl3LqrEGkk1pIb7kUsUl2M9/ssvlKoLTOcmlXxuZ63NOlc54zc9eU45RHJ7oE9023Ka/MM7ma4q5ySfblHhi8wtUY71YCGOvUMbWSaeBREzEjHkU7ZfPUCzN7UA5f9NDor/FOTV2OhVYIugs2azSV26/fntVBDf1P2K7ZQc3Q7hixU1PDEWXLREMUbZNqYyX3btIH+J8dQZfhjaqxkXXtCgTdtvro3cmH2fGP7Pzk5LjLJlBoEJjgQBTmkTlHSQrP8wwjQ2Mh2wumKae2YkZQxh5XSro+1w0VajhKlF9AsEZ6mNsV4cvVVG5R0aLpHNVeMDxHDwSZi37jQQlJxzTbzcXFZd4i39zo2rTl83vnDuo9XYvxhC5Re1HxGETp+wBzv2yeATw4MP6Ls/ePvcwRrHXRu+3dDnrYUfVu+1h7y2Of7FL7RLbKNHKyTnvxpIBHftfxwbISXV+2cm0IYYSGAU/Z5tWXBcYurstXMud61HijeStTVpSR/0ehS0rCvUJ5K+LGlqeTOcMJQ9cbcCHoECcwm5zOoP8gIMHkrwSyO0zT2CGZ0iXGWXndMTV3LdXriqpyM0mYPnHrPUD9hrq46C5wVG64i7HmPfZGn97s1+h+P+fJRrFJ2xuRys1B7elMXbgFisoDl2zh9W/z1qPYYfO9RmWf9kcU5duGra8YXvTOorLh5mulUlh+uJDaQv2ETKXTcisC2yOXMjUmQG4H3X7Dal+/fg8yKNjlrU2JkwRL375+zfKO88KnwJzod0Zj9g1nq1gsvn3V5s5wFcuTruphifjcXSXr4C0UrbpR7JPijsHItxmxvx/sluTiB3bF58c+Po6A4hVDnrAUybevbCfg4c2r7z72tUNRzP2mx7+7Cq/CeUlxcZNWXqdQD/wH4cQpuWQfp/5gd3BY63zT+XMPNlf8VrC1T3abBXmKm+JOI3bEQmpgEXZp0yclYJBAutYyxcmnRdDCCnJBvQd4+uff/8E+DtiHfCH7kRYSh7r5h0AL9KTszAq2vg7c1G7l2vT5TwqzmJeIz0kPAAh5ICK7oDDR/rITle8GV3QOYOjBRPk4eHykYUQz8lJ6SZgHdf34cCcPn+Q5N+LevHggGq05bbyT3x83r3npaZFZMXFdESVPwl5XjqrTk/M5BcLsKnlt7qVjrtte/M485pNREdP02EMHilqm5qra4MzuLlf1k+FGnwzZF/3SMpsK76sU1qL+TsYIfRJbrUseHsy5A4Hm8GZq64riZDLQpDo6tv8FR+ZEnw== +sidebar_class_name: "post api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Creates a preset template for the app. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/delete-app.ParamsDetails.json b/docs/release-management-api/apps/api-reference/delete-app.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/delete-app.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/delete-app.RequestSchema.json b/docs/release-management-api/apps/api-reference/delete-app.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/apps/api-reference/delete-app.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/delete-app.StatusCodes.json b/docs/release-management-api/apps/api-reference/delete-app.StatusCodes.json new file mode 100644 index 00000000..ac103cca --- /dev/null +++ b/docs/release-management-api/apps/api-reference/delete-app.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Delete app","content":{"application/json":{"examples":{"204 - Delete app":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/delete-app.api.mdx b/docs/release-management-api/apps/api-reference/delete-app.api.mdx new file mode 100644 index 00000000..7d95f329 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/delete-app.api.mdx @@ -0,0 +1,69 @@ +--- +id: delete-app +title: "Delete an app" +description: "Deletes an app - only workspace owner can do this, needs standard license for the app." +sidebar_label: "Delete an app" +hide_title: true +hide_table_of_contents: true +api: eJy1Vttu4zYQ/RVCQJE2cHzbLQoYm10YsNsaTbyB7QRos0FAS2OLtUxqScqOK+i1H9BP7Jf0kJLtOI4XyEPzoFDizJwzwzlD50FEJtQitULJoBP0KCFLhnHJeJqyC6ZksmFrpRcm5SExtZakWYjtSDEbC1NjkigyzFguI64jloiQpCE2UxoG5MLUg1qgUtLcgQyiHUw3TbFjKMy0sJugc58HVi0IPO4fiodaYPncYB3AzgR4T7nmS/hp420lXhBLRAgiHPmU2xhrTV8zoQk4VmcEgDCmJQ86iL5JnYexWsh5UDgMTSZV4Gvcfrv53v17rSQuD8QOlbQkrbPCB+Tqc2r8aZxpHtATX6bJLhjq98wb31Y8ycAgL/xfLXjfbB0D3kqe2Vhp8RdFb4NEOEAe+D8DRaTIpd8fjR5vh93bya+fR4M/+j1gLMkYPqeX4Hua745p3pBeCmPwwiKS4u1c34HrcZAThG/6o+vBeDz4PHzs9YeDF6yPw2yp/9hsHlMfgKWWPGFj0iv0c19rpd9GH3FB//VAJ1IYDCf90bB7dcB8rNDRMdqRrYHM1lr5zqzYuz3lBBP5NgpqZY93gkYuosKLx+GWesh0gp18yg3djq6KhoYP1hdLLoG1RPjGqt1AYqaxasF3xbXg0yqfyqus1YxnCaoQxNamptOAj6hPBVRjqC4UXA/LOYHMSyLMhWGIw9bCxl7/Xn1Udzk97MU+9l89ciX5nToB9htttpqOiUekjyBvuhMMntCVUW+YVSwDbvdmgNGUJAbm1XDYNrM/yMCVVMiZ8mjCJs5iVFaJXe+q5OK48qCuJdiqXW8dMTg/v1Jq4Q5uO+lUEjnXT+fn7HeV+SE5EzJiwrKYNHXYB85iTbPLs9eOBmlfRCo0DbjQUz22y+QTTtTUUy2WSHKIhC4rst+1m3u6eAEqnnctPHoIccYs13Oyl2eP04TLxdnHu5Yvjkkp/NDgH7/IL3KyZ4zDShI2JWgn1YSmpwhzn/1MU5258raMZe1m+6c6irTAiWaakDC3bIM0Y74ithRz7d2s8qWQtPaBp4TiOGOSdQf6zQqUQVDdi3kmIvIleCUVgdgOAzn9+/c/7K7NrreO7Bfn6DIMcNKpMhbh3WFX3XB4u7080nyv///vHqya3NKTbaQJR4+DqVduXmn7PujgSoNWYvB3r3kpaZ0Uhfv8NSPtLsuHvYK9/CNh3BrTYsYTQ99I7vtRdUP+wE4x2mpRbvyg8MMswHIBZfort3iAVSVOh15udMOQUvvM5WiMuiGwm2q9/lV/0oe5k+nhCFj4EVAt/C+D1xgdyntLzz2L2gmXPC8HTFHs7Mutkx67EVQl75LANPsPBSgkJQ== +sidebar_class_name: "delete api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Deletes an app - only workspace owner can do this, needs standard license for the app. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/delete-custom-access-link.ParamsDetails.json b/docs/release-management-api/apps/api-reference/delete-custom-access-link.ParamsDetails.json new file mode 100644 index 00000000..a8dd24f0 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/delete-custom-access-link.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"installable_artifact_id","in":"path","required":true,"description":"The uuidV4 identifier of the installable artifact.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The uuidV4 identifier of the custom access link.","schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/delete-custom-access-link.RequestSchema.json b/docs/release-management-api/apps/api-reference/delete-custom-access-link.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/apps/api-reference/delete-custom-access-link.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/delete-custom-access-link.StatusCodes.json b/docs/release-management-api/apps/api-reference/delete-custom-access-link.StatusCodes.json new file mode 100644 index 00000000..2d3b9d59 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/delete-custom-access-link.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Custom access link deleted","content":{"application/json":{"examples":{"204 - Custom access link deleted":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to delete a custom access link. Only Admins, Owners and Workspace Admins can delete custom access links."}}}}}},"404":{"description":"Installable artifact not found","content":{"application/json":{"examples":{"404 - Custom access link not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}},"404 - Installable artifact not found":{"value":{"code":"ERR_NOT_FOUND","message":"The installable artifact cannot be found."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/delete-custom-access-link.api.mdx b/docs/release-management-api/apps/api-reference/delete-custom-access-link.api.mdx new file mode 100644 index 00000000..340551a9 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/delete-custom-access-link.api.mdx @@ -0,0 +1,69 @@ +--- +id: delete-custom-access-link +title: "Delete a custom access link" +description: "Permanently deletes a custom access link. The install page URL will no longer be accessible after deletion." +sidebar_label: "Delete a custom access link" +hide_title: true +hide_table_of_contents: true +api: eJy9V+1OIzcUfRVrpIoW5QOyVJWiZVfRkm2jhYBCoGpZhJwZJ+NmYs/ankAazd8+QB+xT9JzPZMEyISK1ar8CJ6M7z3nHvseO8sgEjY0MnVSq6AdXAgz40oolyxYJBLhhGWchZl1esZ4GAprWSLVtMGGsWBSWceThKV8ItjV4JTdSzwpzRKtJsKwkShj5CjBcOzwnc8KsEZQC3QqDKeHXgTsE4/3wWN1fNgpkDDNijAz0i2C9s0ycHoqwPTmNr+tBY5PLMZBryDCCaZjnBzz0NkAE1Ju+AxZjfXBCg9Akpvpd7ycficjQEkSIeUuxtiIL5k0AtScyUTtmVJUf5bJ6PqIyQiCybFEdXrM3EYYz2cFQAXbMBYzHrRRxiIlJtYZqSZBntc25L4hj4qFe5HFLaHZVCsrLL1vHRzRv6eIH7aSlluFiIdaObCgKJ6miQz9+jb/sBS6DMQDn6XJOjmrsxeyYc6cJxkYLnP/VwuODg63CV0pnrlYG/nnaykgHSg8iX8EikwRydMdDO6u+p2r4S/ng97v3RNgzEAWm/45+Ibmm22a1FsSvaAVKlTy9VzfgOt2kh2EL7qDs97lZe+8f3fS7feesf5NZyzmc0HNmq5TWuZ0qf6Orj9XMIZONMMGr7Hze4XGYlxF7FdtpjbloShfspCrVabtPLbxSKmKHdaraB8wdWysM/Vq2Xbssk2+HQr2z4d3H8+v+k+Vo35Dj+jMoFhUSWngc0WmsiIA/kcJr4ascpTn8BtVfzw4qFIVPqh4wi6FmcMjusZo8zoxkdfXVpVoR0m9/rA76HdOn1R0qWHKMTyH3QOZ3Rvt7adkT+80nQjFBgpqhRO2g+YjFeorFWxzucPP82ax9erFstf91sPsKPeHCnEvjoXMJMi+HHErcIrlTQNcjOs4CsF3BorNeasJcWxzfojYOTeSwLwmZVSh95hnCZQMYudS224iRjZGEvZqRUPqoMq8CyKM0pRnqIu9eXubFn5RbzeH4KX/1iOXR+HaxgH2SSxWp0cseCTMFuRFZ8iUID24WVC/Z8DtXPSwmZLEYnp5DK1czW8Gv7GlGmuPJl1CMwaFSuxsrRLlIXmgawE2bzUOtxjs759qPaXFH2vjK9VJRKHv9/cZGRN5x1jCVaRjsTCizd5yFhsxPt6rWhqUXY90aLE7IvHQiN0seY8VtY3UyBmK7KOg45Lsd62DDV08ABWf14f4OEGKPea4mQh3vHc3Sria7r27PvTi2FSEb5v83Wf1WQ03jIsLD/ovEqkRaBwRMTjzRzEyGcl7aB1rHbR+akCkKVY0MwIFc8cWK/+dyYnxYVgJkkKJe594JCAOTRaqQaAvKlAkgbr1CW4CwktQUYpEbsJATf/89Te7brGzVSD7mQKpwgArnWrrkJ4Wu9wNJy/cBZ8v8HLjKP/zfbLsAyceXDNNONoAxfjmXpYWchNUWghi27svhRUu4gMiumHG0IryLgv7MEme09dfMmHownq7cQtvNZG0NIa7jXlin9/mHkv3/aC89/3AvuquWSnGyinUwtuYt+sAwyl8Y/e9mG6n35549eX0a2iD4S1mlY5HMhcv6FdE6h6FbJ1v5Kzr4+ake9oddjGdvO+pr069r5YD/zOkitFTz1zRo09SsDJkuSxcO8/X84tXOyPWvr5aMyo+z/8FY/XEhg== +sidebar_class_name: "delete api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Permanently deletes a custom access link. The install page URL will no longer be accessible after deletion. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/delete-installable-artifact.ParamsDetails.json b/docs/release-management-api/apps/api-reference/delete-installable-artifact.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/delete-installable-artifact.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/delete-installable-artifact.RequestSchema.json b/docs/release-management-api/apps/api-reference/delete-installable-artifact.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/apps/api-reference/delete-installable-artifact.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/delete-installable-artifact.StatusCodes.json b/docs/release-management-api/apps/api-reference/delete-installable-artifact.StatusCodes.json new file mode 100644 index 00000000..e015626a --- /dev/null +++ b/docs/release-management-api/apps/api-reference/delete-installable-artifact.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Delete installable artifact","content":{"application/json":{"examples":{"204 - Delete installable artifact":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"422":{"description":"Installable artifact has been uploaded through CI","content":{"application/json":{"examples":{"422 - Installable artifact has been uploaded through CI":{"value":{"code":"ERR_UNPROCESSABLE_ENTITY","message":"Only artifacts uploaded using the Release Management Public API can be deletedthrough this endpoint."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/delete-installable-artifact.api.mdx b/docs/release-management-api/apps/api-reference/delete-installable-artifact.api.mdx new file mode 100644 index 00000000..712d3897 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/delete-installable-artifact.api.mdx @@ -0,0 +1,69 @@ +--- +id: delete-installable-artifact +title: "Delete an installable artifact" +description: "Deletes an API-uploaded installable artifact of an app." +sidebar_label: "Delete an installable artifact" +hide_title: true +hide_table_of_contents: true +api: eJylVu1u4kYUfZWRpSptFD53q0posyu6cVvUhCAgkbbZKBrsC57GzHhnxiQU8bcP0Efsk/TM2JiwwEpR+WFsfD/OPffew6yCmEykRWaFkkEnuKCULBnGJesOerU8SxWPKWZCGsvTlE9SYlxbMeWRZWrq7HiW1YOzQGWkuYvSi6s4va1Xt3SCpaEo18Iug87dKrDqkZD47n59fxZYPjO4D174sY2jCWCQcc3nCKyNd5Z4QDIRI6pw8DNuE9xr+pILTQBidU7IGCU050EH6ZaZ8zBWCzkL1i6pJpMpaci49+3mW/d1iJSDHCBZpKQlaZ0bqEhF5Flo/Gmc7yqgZz7P0io6q7FvhYPRgqc5MK7W/nMWvG229iHdSJ7bRGnxF8Wvw4BwwLDj/yIpIsWOoHA4fLjpd2/Gv10Pe3+EF8gxJ2P4jL5OvoX5Zh/mgPRcGIMHFpMUr8f6Blj3gxwBPAiHV73RqHfdf7gI+72vUO+HqaC32/vQe4cmPuGGTYgkqxbDJlrls4R97L2ytHYbpb0+ydFeDYbXH8PRqPvzZfgQ9se98aed6q9luqxSmG3o3GARkIDYEGPJDbErLuEyRx1skE9QhFMCFmHTJwTm3OzGG0A2EYaRjDMlpK1XhP7YbB4iFHsrecpGpBekWai10q8jDXE9aYcCHSGm1x+Hw373coeMkYKIJK7wJ1fmk1ZeDEr07p1yIlYUG5wVstIJGi9WtlZx2ViJeO1lzaEphCnXKexXE/B5M7xcN3TBbW1ecdtYtBso1zQWLfguuBYuqq+y9CoYnPI8BTdBYm1mOg34iPpEQL4M1YWC6y7JYzSyAMJcGIY47EnYxHfYyyD5Nt1vZXjkf/WZSzGuZBLJfqflRlwTwsTovZSD7phJihy5esmswkhROTJpamBeqvRGM3x7A0e0kFPlswmbOosDE4g4jh7wWiRbtOutPQSnp5dKPbp2TpX2lao0dq4fTk/ZJ5X74Z0Kib8xbBdp6rB3nCWapucnh1qDsmuxigz6HdNzPbHz9AM6auqZFnMU2UdB5yXY79rNLVw8ICuuty1cLhDihFmuZ2TPTx4mKZePJ+9vW54ck1H0rsHff5af5XiLGM1K02LRMk1YBawoBOsXmujc0dsylrWb7Z/qIOkRHc01oWBu2RJlJnxBbC5m2ruhE44KSU8+8IRAjjMmWXdJv8lAEQTs1ma5iMlTcKAUgdguB2r69+9/2G2bXW0c2a/O0VUYoNOZMhbhXbPLaXhx0Djyv7rT49VWJv7HGaUca0vPtpGlHFMNbH5XV+WO3wUHdxy+HZwysDUJKnFmq2K5dbpeu5+/5KTdgeZ+u8teCGJh3D3UZMpTQ9+o6vtheWj5gR1DutlKufSS4cUuwO0jdtSfgtb3sCrX1GUvXnSjiDL7wmVPZp0cVKp3EV6G4xDmbmF3xeDRi0F5409vhxDtLvoGnruuz464rFaF1KzXlX3x6qhHJUZl8a4I6Np/fBW2jg== +sidebar_class_name: "delete api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Deletes an API-uploaded installable artifact of an app. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/delete-outgoing-webhook.ParamsDetails.json b/docs/release-management-api/apps/api-reference/delete-outgoing-webhook.ParamsDetails.json new file mode 100644 index 00000000..89ded920 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/delete-outgoing-webhook.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the outgoing webhook to update.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/delete-outgoing-webhook.RequestSchema.json b/docs/release-management-api/apps/api-reference/delete-outgoing-webhook.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/apps/api-reference/delete-outgoing-webhook.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/delete-outgoing-webhook.StatusCodes.json b/docs/release-management-api/apps/api-reference/delete-outgoing-webhook.StatusCodes.json new file mode 100644 index 00000000..15a9f651 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/delete-outgoing-webhook.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Delete outgoing webhook","content":{"application/json":{"examples":{"204 - Delete outgoing webhook":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/delete-outgoing-webhook.api.mdx b/docs/release-management-api/apps/api-reference/delete-outgoing-webhook.api.mdx new file mode 100644 index 00000000..bcbe0528 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/delete-outgoing-webhook.api.mdx @@ -0,0 +1,69 @@ +--- +id: delete-outgoing-webhook +title: "Delete an outgoing webhook" +description: "Deletes an outgoing webhook." +sidebar_label: "Delete an outgoing webhook" +hide_title: true +hide_table_of_contents: true +api: eJylVu1uIjcUfRVrpCptlPC1qSqhza5QmbaoCUkHkqrNRpFhLozLYM/aHhKK+NsH6CP2SXrsGWCTgVRR82MyYN97z7nX5+BVEJMZa5FZoWTQDrqUkiXDuGQqt1Ml5JQ90ihRalYLTgJD41wLuwzad6vAqhkh5u5+fX8SWD41eA+uNlG/FlEmwKLKSHNXoRdva2w2lvuQPOOaz7GijU8v8QG7RYwl4bBl3CZ4fw54mBDLcxHfnjERk7RiIkgzNWEWCy8pMKtYnsXckiOj6XMuNAGS1TmB3DihOQ/aYLbMXGljNYKDteOnyWRKGjJuvdU4c//2ta5SE4XGSlpAcyE8y1Ix9r2o/2Fc3CqgJz7P0m1mdsoOpcKGBU9zYFut/d9JcNZoVqHcSJ7bRGnxJ8Vvq490qP8s/ouiyBS7xoRR9HDT79wMf7qKer+HXdSYkzF8Si+L72C+q8K8Jj0XxuADw+jE27G+A9ZqkgOAr8PosjcY9K76D92w33uBuppmC73ZqkIfWC5jrmMGhIRjwbaH6W0Umi1QOJzsAJXBsNPvdqLuw0Xv+7A/CB+i8JebXvSC0jARho1I0kTYTUoou1puorSXC4BLGluKGXDXtg34ttGoNqAHjlrylA1IL6C4UGul30YeeUF+f6IDxHv9YRj1OxfPeA4UXCMpdCIte9TKi7ZE79aUs53Yi8r7DHykHdQ38jot5WXqKxGvvcs5JIUL5TrF3tWIG7qJLtZ1jSx4P51ziepzFKwvWnVQNfVFE7ELrgUflQzLqKJ7E56n6EuQWJuZdh0xojYSsBhDNaH2GlsBhLk0DHnYo7CJn5S3KvIjut+58sB/6yuX3ry1MhT7mZYbJ02Ix6QrJa87Q4YD4Bqrl94rUbdz3WNjnqYG20tL3ujbjzZwTRZyonw1YVO3Iyq6xC63XXJ5XHvQ16LYolVrVhAcH19gEG6UmzOp0tiFfjw+Zr+pHEgkmwgZMxzphDS12XvOEk2T86N9owHt01iNTR0h9FRL7Dz9iImaWqbFHCT7IHRegv2q1djBxQdUxfO2iUcXKY6Y5XpK9vzoYZRyOTv6cNv0zTEZjd/X+YdP8pMc7hBjWGkK+cFOMk2QAWQFc/mBRjp37W0ay1qN1nc1NGmGieaaQJhbtgTNhC+IzcVU+zBMwrVC0qNPPCI0x20mWXNFX+1AkQTdPZ3iV5J8C/ZQEcjtaoDTP3/9zW5b7HITyH50gY5hgElnylikd8MuT8MrV4aX813t7OG/bhrlubX0ZOtZynFsUdyLcVUK+C6oCBhxbdwXIIkEMN2WVaFcna7X7uvPOWl3ebnfCdWrPBbGvcMmJjw19Arsr6PSm79h/+PqsZfdRqpy6X3Eu1+A1xmE6+9B63vsKrXrUBcLnfGYMvtFSMV3nUdsbbAbXoTDENudip87xMw7RPnib3j7ED1X/waee65PDoSsVoX/rNfb/cXSwYitQ5XkHQmY3b8uq6sk +sidebar_class_name: "delete api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Deletes an outgoing webhook. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/delete-preset.ParamsDetails.json b/docs/release-management-api/apps/api-reference/delete-preset.ParamsDetails.json new file mode 100644 index 00000000..cd2bbaec --- /dev/null +++ b/docs/release-management-api/apps/api-reference/delete-preset.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the preset template.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/delete-preset.RequestSchema.json b/docs/release-management-api/apps/api-reference/delete-preset.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/apps/api-reference/delete-preset.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/delete-preset.StatusCodes.json b/docs/release-management-api/apps/api-reference/delete-preset.StatusCodes.json new file mode 100644 index 00000000..603b4607 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/delete-preset.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"The deleted preset","content":{"application/json":{"examples":{"200 - The deleted preset":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/delete-preset.api.mdx b/docs/release-management-api/apps/api-reference/delete-preset.api.mdx new file mode 100644 index 00000000..173eaf79 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/delete-preset.api.mdx @@ -0,0 +1,69 @@ +--- +id: delete-preset +title: "Delete a preset template" +description: "Deletes a preset template." +sidebar_label: "Delete a preset template" +hide_title: true +hide_table_of_contents: true +api: eJyVVuFu2zYQfhVCwJAtSKzYbTHAaFoYs7YZS9xMdgJsaRDQ0tniLFMqSTnxBP3dA+wR+yT9SMl2E9sBkh8KJd7d990d7zNLLyYdKZEbkUmv6/UpJUOacZYr0mSYoUWeckMt78TLclLcGg7ijemVM8OmpqhQwqy87m3pmWxOCHd7V92deIbPNNZebao9fMq54gt4K+3MJV4QUcSIIyyNnJsE66fcxgmxohDxzVsmYpJGTAUplk2ZwcYeuoq+FEIRuBpVEBhGCS241wW9VW7xtFFCzrzKkoR7nklN2u53zs7sv1342OUcN2jAiDJpQMVa8zxPReTq4/+jrUvp0SMHn01Qdsr2RMHekqcFGJWV+zvx3p61dwlcS16YJFPiX4pfB41wgH7i/x0oIsW2HEEY3l8Pe9fj3z+Fg7+DPjAWpDWf0XPwLc03uzSvSC2E1nhBolK8nusbcN0NcoDwVRBeDkajwafhfT8YDp6x3g2zod7u7FIfGS5jrmIGhoTDwDZH6HUptDtI4XCwA6mMxr1hvxf27y8GvwTDUXAfBn9eD8JnKY0TodmEJE2FWYe087oDN82UmwwQlxTZ8wberU0B3u074wPkqCRP2YjUEsMVKJWp1yX/zh3z/YEOJD4YjoNw2Lt4kucog0AkmE/2AGT2oDI3qg17u5dZFapnyTupJaPr+fVQab8UceVkyeLXMlOoFBblhGu6Di8qX8EX69MFl8BcAMZfdnwkqP1lG75LrgSfNHk1XnXNprxIUQ0vMSbXXR8+ojURkBNNLZHtVa6aCLNhGOKwB2ES1x8nS+Qac7eV0ZH76pAbMd3IFsD+oNVaKhPiMakdyKvemKHttpxqxUzGCuD2rgYs4mmqYd5o7nqqXUM9W1ohp5lDEya1FmFdJXa5qZKNY8uDutZgy06rvcPg+Pgiy+a2geuTmKWxdf14fMz+ygowkWwqZMxwkBNS1GXvOUsUTc+P9rUGaZ/GWaR9uNBjKzGL9CM6qlu5EgskOURC5w3ZHzpnW7p4ASqeN208+ghxxAxXMzLnR/eTlMv50YebtiuOzil67/MPn+VnOd4yRrPSFEMHEcHxwuHHMEFSfqWJKmx529qwzlnn5xaKNEdHC0VImBu2QpoJXxJbiJlybuiELYWkBxd4QiiONSbZsqAvVqAOguqezvAzSK4Ee1IRiG0xkNPX//5nNx12uXZkv1lHm6GHTueZNghvm92choM//8+7W24l4eU7Q3NmDT0aHx9xZAHsBrFsRvbWa0YW1l1cATAECYjZjbKeVZVWlf38pSBl7xd329F0cx0LbdeQgylPNb1A9cew0eCf2GtvE3sTWU+kXDm5cNLmYTnHfLr7THUHq2ZELdV6oxdFlJvvXHZE1UrBRuP6wUUwDmBuh/WpEMydEDQLd/Pax+jpkK/p2Wd1csClLGuZqaqNfb110GMjRE3yNglo2jdOXIzK +sidebar_class_name: "delete api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Deletes a preset template. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/generate-installable-artifact-upload-url.ParamsDetails.json b/docs/release-management-api/apps/api-reference/generate-installable-artifact-upload-url.ParamsDetails.json new file mode 100644 index 00000000..b20c21df --- /dev/null +++ b/docs/release-management-api/apps/api-reference/generate-installable-artifact-upload-url.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"An uuidV4 identifier for the installable artifact.","required":true,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":true,"description":"The uuidV4 identifier of the app the artifact is connected to.","schema":{"type":"string"}},{"name":"file_name","in":"query","required":true,"description":"The name of the installable artifact file (with extension) to be uploaded to Bitrise.","schema":{"type":"string"}},{"name":"file_size_bytes","in":"query","required":true,"description":"The size of the file in bytes.","schema":{"type":"string"}},{"name":"with_public_page","in":"query","required":false,"description":"Optionally, you can enable public install page for your artifact. This can only be enabled by Admins, Owners and Workspace Admins. Changing this value without proper permissions will result in an error. The default value is false. ","schema":{"type":"boolean"}},{"name":"branch","in":"query","required":false,"description":"Optionally you can add the CI branch the artifact has been generated on.","schema":{"type":"string"}},{"name":"workflow","in":"query","required":false,"description":"Optionally you can add the CI workflow this artifact has been generated by.","schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/generate-installable-artifact-upload-url.RequestSchema.json b/docs/release-management-api/apps/api-reference/generate-installable-artifact-upload-url.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/apps/api-reference/generate-installable-artifact-upload-url.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/generate-installable-artifact-upload-url.StatusCodes.json b/docs/release-management-api/apps/api-reference/generate-installable-artifact-upload-url.StatusCodes.json new file mode 100644 index 00000000..2eefc053 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/generate-installable-artifact-upload-url.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Get generated signed upload url","content":{"application/json":{"examples":{"200 - Get generated signed upload url":{"value":{"headers":{"Content-Type":"application/vnd.android.package-archive"},"method":"PUT","url":"https://bitrise-storage.com/platforms/android/apps/io.bitrise.test/artifacts/9a35afac-81a4-488d-a986-3c13015d70a0/artifact.apk?signed-url-data"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"examples":{"400 - when app_id parameter is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: app_id"}},"400 - when file name parameter is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: file_name"}},"400 - when file size bytes parameter is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: file_size_bytes"}},"400 - when artifact type does not match given connected app":{"value":{"code":"ERR_ARTIFACT_TYPE_MISMATCH","message":"The platform of the artifact does not match the platform of the given connected app."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - No permissions to enable public install page":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to enable public install page. Only Admins, Owners and Workspace Admins can change this value."}},"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/generate-installable-artifact-upload-url.api.mdx b/docs/release-management-api/apps/api-reference/generate-installable-artifact-upload-url.api.mdx new file mode 100644 index 00000000..9c4fc2e6 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/generate-installable-artifact-upload-url.api.mdx @@ -0,0 +1,69 @@ +--- +id: generate-installable-artifact-upload-url +title: "Generate an upload url for an installable artifact" +description: "Generates a signed upload url valid for 1 hour for an installable artifact to be uploaded to Bitrise." +sidebar_label: "Generate an upload url for an installable artifact" +hide_title: true +hide_table_of_contents: true +api: eJzlWHtvGkcQ/yqrkyonkTmMH42D8hB1iIMaYwtjV2lioeVu4bYcu5fdPQhF/NsP0I/YT9KZvQeHORPjJG2lRoo5uJ2Z3/xm57E7d3ymPcUjw6Vw6s4pE0xRwzShRPOhYD6Jo1BS+FAhmdCQ+2QgFamRQMbKPlJBuNCGhiHth4xQZfiAeoYYSfoslQY18PUnbhTXzHV2HRmhGbDZ8gtWW0s9jVTNlZW/UiEIaebFipuZU/8wd4wcMUD84WZxs+sYOtTw7BQUkEyDdmBBRBUdM8OUtsICvoBd7oNWjn5H1ATwvEpGQ5A45v71IeE+E6CNs8RlE7BSn9EzxT7FXDFwy6iYAWgvYGPq1AHxLEKjGkgQQ2ex2M1x0CjqLbF8ipmalWhaBdcFDOvo5MCCA4XJZxYMroknhWCesaFAoPcBNuAh69nnrbGhVAandH+gbvJoyk1A2GfDhAbZx5t3zb0ha/476/VnsI+3B46yGXCLkQtiVd0XAbrUi+J+yL1eRIcbuBvQUK9hOLcPQNdsl8xkTDxIMCYsd4nSjE6Cyu1+nGEu5puQdAMMN4hJEc6QzkTcBzdIwx+D+C45n0LKQZYLn/wi1UhH1GPpS5ecBFQMwS3gADRB1seMoFcyNiRSmLsE/o+5xphpeAVgFNNxaJAsxKuUVAiEEZ8NKL5ItIA667RLysjsSxkyKlbY7CsqvODBHOYUUt+3IT1pkUTlaoIEVANTTJBhWot8YO/eEQcGB6GcflOUmdIkCJuA9mebgd4gEh1BqCAf4P3+3h5+3K78pqByrfaDASggkKYGRaG+wEa0Bbz6m0b5ucM+03EU5hZIhXxJJSy0uwIfAgb5rqzwSWKn0k3cKNqaCN+FLask913YsSNIgApVXsAnzFnsOlDhA4kN5eKqC4CtDScwJtL1arWf1JGKNlKBnOvJcTUKqYEEGutqqrUK1nSVSzdd7ULem2pGvq4+owdHFB4rxzV6WDk8PvYr9Nnxj5UDr3awVzvyn+7RvXy5S6PRq8TtCmCp+NRQCAf+23UOy4LwEzDTgU0DRrcj/NASPg1gXyTNhOQdD3POpirshSLjnvSR3man07todBpnzW6z0ztrXV622qcOcqk1Fq960jsLWkjaAfOMZuPIzPBXLuyEUE8xOKmfGTJbTW1f+FfBLZtaGT5b/m29/w+gLPSxW1iXYxZkCfElwBXSkDE1UNmGkA+i0PAhHHfhbnS6rTeNk26v+/6iidjPGt2TtyvgsYpniZIPGJn5W5ZNydoSNG4hDWrraXAlaAyZrMB7f9s8qAFDK/J3OH7Vblx13553Wr82X6+4uyK8hHmwDvMi74HQ5QTfHusBYG3LlV4KA8/dzf7Ozdfs2F133u69brZbtxx6D70loBNIvS1MueQch4d7jAu2b3k4MbDCvOCmGxZdXOfpQX6sq8mic1RWS1sQCAXdlVwyNYEcbuJMsl2Ejmy+lSu6w4VWG2pAu/FuBfmlxM6EeT8Fy2SqpO3LKfq8aw0ZVn17FKk71cLQXFk2oDn3F9Wkh1bi9FSEqJJzTdLx5n2q2VXn3aKqGMxT0PPGVACSMRivTvaTHjepgeyEKo4GrLepVMKkHdoK3ZNGPO+JXK4dlezgnNCDagjosROjLQB2MrE7AkeR7BR3aX+1ltOzXD65gLGf2SybppLRYM3kRaNLoKIgyWqGmzkGu42LFuzHMMS5Pztcpdlsw2x3JRcDaa1xE+KKTsISOctZQj1ID/CaGJvsu7U1BE+evJNyhGHNDoUy9FH01ZMn5H060Q045AyHuY0pVifPKQkUG7zYKQsNuF3xpQfzh/DZZzcw4/AVRFS7keJjcLINDr1Iwf6wv7eEC1/AKvy9rsGf16BihxiqYD+92On1QypGOy+va5YcHTHveZW+/Cg+iu4ScTLD93FcjxTz0vmXvGF9FSO9NW3I/t7+UxdIGkFEY4XJTo0dXG1xGfNhMudBJJAKwaZWcZ8BObiYCReNbmQgUQLsVoZwtGWWghJXOJtaG+DTX3/8Sa73yVkmSE5RED3EgTCS2oB6DHa6GwoXHKJ4tbHhJsO9Hfj5sob8YxcmaWYYOCrj1AqJsUgH3HlaMT44pRUDZOv2bqFQNCALA2AGZeZJsVDhYoE/JycXLCU+1/bQWH52KVLwqJMecx6Tr76UKHVzBLWgcEmSll3HwRPYg2F+j/uJDeiLNynfxoGN9xRfQrJyQfJAPP+fi4oNbJZc9nw1nV99Z7EBb36d8l1QbntnsYnY5Z3KEurNcmR5eJF60LVuKdJsXBGzIsrMAzwA38CqdH5BvMmLhuexyBRE1uZQdDQfC0+beJmBY8zqiDSyI1L6YK/Ey+Csjj8ZNvyLgS8Vmc+TAQxaQrY+eXWnRD6ipZ6jBzDt/Q3HZG3k +sidebar_class_name: "get api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Generates a signed upload url valid for 1 hour for an installable artifact to be uploaded to Bitrise. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/generate-public-asset-upload-url.ParamsDetails.json b/docs/release-management-api/apps/api-reference/generate-public-asset-upload-url.ParamsDetails.json new file mode 100644 index 00000000..3fd523a0 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/generate-public-asset-upload-url.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier for the public asset.","required":true,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":true,"description":"The uuidV4 identifier of the app the asset is connected to.","schema":{"type":"string"}},{"name":"asset_type","in":"query","required":true,"schema":{"enum":["app_icon"],"type":"string"},"description":"The type of the public asset."},{"name":"file_name","in":"query","required":true,"description":"The name of the public asset file (with extension) to be uploaded to Bitrise.","schema":{"type":"string"}},{"name":"file_size_bytes","in":"query","required":true,"description":"The size of the file in bytes.","schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/generate-public-asset-upload-url.RequestSchema.json b/docs/release-management-api/apps/api-reference/generate-public-asset-upload-url.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/apps/api-reference/generate-public-asset-upload-url.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/generate-public-asset-upload-url.StatusCodes.json b/docs/release-management-api/apps/api-reference/generate-public-asset-upload-url.StatusCodes.json new file mode 100644 index 00000000..da1065d6 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/generate-public-asset-upload-url.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Get generated signed upload url","content":{"application/json":{"examples":{"200 - Get generated signed upload url":{"value":{"headers":{"Content-Type":"image/png"},"method":"PUT","url":"https://bitrise-storage.com/apps/632d90ae-9e6a-4211-901d-971de7645c0c/app_icon/9a35afac-81a4-488d-a986-3c13015d70a0/icon.png?signed-url-data"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"examples":{"400 - when app_id parameter is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: app_id"}},"400 - when file name parameter is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: file_name"}},"400 - when file size bytes parameter is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: file_size_bytes"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/generate-public-asset-upload-url.api.mdx b/docs/release-management-api/apps/api-reference/generate-public-asset-upload-url.api.mdx new file mode 100644 index 00000000..69de46c4 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/generate-public-asset-upload-url.api.mdx @@ -0,0 +1,71 @@ +--- +id: generate-public-asset-upload-url +title: "Generate a signed upload url valid for 1 hour for a public asset to be uploaded to Bitrise" +description: "NOTE:" +sidebar_label: "Generate a signed upload url valid for 1 hour for a public asset to be uploaded to Bitrise" +hide_title: true +hide_table_of_contents: true +api: eJzNWNtu20YQ/ZUtgcKJYYqiLN+EXKA0iis0VgxZMtDGhrAiR+LWFMnsLuWogl77Af3EfklnlqQuFm3HrdE2DzJF7cycOXPdzC0flCdFokUcWQ2r86nXalxFNmtHzOMKWDxiPEmY8OJI7TE+0iAZZyr1PFBqlIYsTcKY+0wHYA6RAD2T0K0IQzYEJiEJuQf+d1eRtWfFCUhO5to+GjyFiL7CeToMhddUCnTfaOzLEA8r8FIp9MxqfJ5bOr4BBPn5enG9Z2k+VvhsZYLMSCoLf0i45BNAnMoIRfgF7QgftQlyMeE6wOdNv3sIOU2Ff1lnwodIi5FAR0exNM4kmQ1ONiooK+FLKiQgfi1TQJReABNuNRDiLCFrSksRja3FYm8JAAkZrEB8SUHOSjR9C6o1hs1fQsWEYsh+BJ4GDEZMKL8JFQkPzO+PIFtpgyidEPPGIzRKpN+xUOYIHSmwbxK6hmckQhiY5ycTRVJl+hnpZC9uhQ4YfNUQKZR5iRxRambZayhj7wSiV/Ct1BmoSvwGg+FMg3o6YJItABuMImJG1cMIrkm3SrAe0Sj+XqtW6c+m/lP0e5yXlo+WxhH+yUs1NZWFgUMuNIliIJEtU5POr4rkMchf+SQJlxaYzR5TiQenPEyBHgJAUqUR/iGzY/cyN8SEj8FJsiTBMg1i6gLn/R5CMlqsQOtENRxnmIXDVjqWKFPx4omDSJVzuF/zT6oc7BM45Ha95rr2SdX17ZMj14ejw/qBV/WcIjmdE75/wEfcs49dXrfrx8e+zU+OD+19z92vugf+UZVXHTpZQVBvM7dsRGL7XHOkm/7tWfUykt+h510MMyj9NELrhtDbACKWtQW2bFpUyBOhFMV6nVEv9om+Vrc7OG92m2etXqs7OGtfXLQ7pxYxqRSSZNobalrTwvIeZjTRe5gkekZvRYTvhN/IMVi5nwUyk5KmqP5TcKuOUIbP1JApmv8ByrVmsMobdztv+hFPMfElHvefmjguur8hf4+H/U6z3/vxU7f9S+v9hnMbwiuY+9swz0EaAnCo4/ART8e6j1i3ldwXklbXxOJTZ/C+1WnfQb2tpoB+UFaZbUQpIx6yC5BTzIiWlLF8GvwDk2nliu5xod3BjOo0P24gv4ipy1EW3aJlditj08Vz9MsOOAbqIWY3aVhONr9sM7+UMxf+wsk6rZ3maxGhyRacrGvOh7it9bsfF46EEPDZnvAIEUzQqDOtZZ1z6qLslEvBh7mXuVTG4IinoV7rwDwRlbwLV0RcujNlQBipYaiHmSlLtWLmF87ShRlYxRp3Yd4ay/kyt5xvaOwnmBVTNBsgWybPmz2GOw6RK2c0s1O02zxv464ahjSCi7UmT3ETXtM4RDSKjTWhQzrRzVhiZ0uWSA/Rg7xmxqa1iruFYHf3YxzfUDiL5TAOfRJ9u7vLfo5TREKtKfKZ0CwACQ32irNAwuj1Tllo0G3bjz3loAh8rQR6Er7FiKpKInFUylkHHXqdg/2+Vl3BxS9oFT8vXfx4jyp2mOYS8+j1zmAY8uhm582la8hRCXivHP7mKrqKeivEy/3ch0SCZ8Y61tcHGMqU6HWVZrVq7aiCJN1gRFOJS1zANZuhmwGfAvbHcbYNYCSIighujeIhIDl0GKIKGX2QgUwJsmuPcdUFQ0GJKwJ1kw306c/f/2CXNXZWCLJTEiQPaalIYqVRPQU7z4bijqHo5nJ3b2Gmg5touiyI02zr55sr5IPL4kaCzFc95t+4TOXFo3GxdfA91s4i36PmeTP5bG00E5RpmGvIWj/BAg2QNDo7z/qIDBcLep0ts9RlfKGoaWCrGvFQ3d1n171+0c0335fsn91fSn27wR6xdpnK27Bl7hB/G+P9V5OHUaxfnp4HyXNeYh5Avn7Neh7gD15mHkOycYta4bleDavnzsH7bvalSIsJFc3W4RUe0OZ8jafykUVAsx+aWNaJXhPZWjnIw+UGcNqiOxBNrs2peGOmYv5g/hukDM7mxCuw0SeFtVRkPs9mLpZ6cT776V6J5VTOPScPcMD/BaPDPQc= +sidebar_class_name: "get api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +NOTE: +- In case of app icons, after a successful upload the icon of the app will be replaced! + + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-app.ParamsDetails.json b/docs/release-management-api/apps/api-reference/get-app.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-app.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-app.RequestSchema.json b/docs/release-management-api/apps/api-reference/get-app.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-app.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-app.StatusCodes.json b/docs/release-management-api/apps/api-reference/get-app.StatusCodes.json new file mode 100644 index 00000000..28e865c4 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-app.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"App","content":{"application/json":{"examples":{"200 - App":{"value":{"id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","created_at":"2025-02-11T09:26:01.000Z","platform":"android","project_id":"af19c6dc-530f-41cf-b6bd-6685986c077a","workspace_slug":"workspace-slug","icon_id":"dd6fadd2-6e4b-4bda-b6e2-aa319cdc89cd","icon_url":"https://storage.googleapis.com/rm-public-assets-storage/apps/f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de/app_icon/dd6fadd2-6e4b-4bda-b6e2-aa319cdc89cd/icon.png","app_name":"Test Android App","current_user_release_management_admin":false,"framework":null,"latest_version":null,"latest_version_date":null,"latest_build_version":"","latest_build_version_code":"","license":"basic","store_app_id":"io.bitrise.test","store_connected":true,"store_credential_id":null}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"App not found","content":{"application/json":{"examples":{"404 - App not found":{"value":{"code":"ERR_NOT_FOUND","message":"Connected app: 'f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de' not found"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-app.api.mdx b/docs/release-management-api/apps/api-reference/get-app.api.mdx new file mode 100644 index 00000000..5bd27daf --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-app.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-app +title: "Get an app" +description: "Gives back an app your user has access to for the workspace." +sidebar_label: "Get an app" +hide_title: true +hide_table_of_contents: true +api: eJylVutu2zYUfhVCwJAtiCzZcZza6AXGmmbGWidwnAJrGwiUdGSzlkSVpJxmhv/uAfaIe5KdQ8mXxPbQYPnhiOS5fOd+Fk4MOlKiMELmTs+5FHPQLOTRjPGc8aJgD7JUrNSg2JRrxqMItGZGskQqZqbA7qWa6YJH0HBOHFmA4iRqEJMwMP2iwGsNUamEeXB6nxeOkTNAVZ/vlncnjuETjd8O0mkHzwVXPAMDSlvaHA8oSMQoRBC+gpspfiv4VgoFqMSoElBBNIWMOz2U/lAQhzZK5BNnSToU6ELmGjS9t3yf/j22ukIZydxAbugZDU9FZC3xvmqiWTjwnWdFupbCXEZseJjztAT6EGR0chpHid9tu+0u+G47Cbtu2AnbbhS1WufdpBWexkDKFHADccBRH4prnbl+y202x3631+r0/GbD9/1PSFek3KCrM6TieaykdUWh5FeITGAV8qTZjTpx5J6d+onbbkYJKYzdTufFWfdFJ/LPzznyrOMU6LScIN/6wrUX6GB0QCUyjjsJj+OW24F26LbDmKNIaLmcn6KuOHqBPyuGUqXIMTWm0D3P00YqPoHGRMpJCrwQuhHJzFOZW5QhutTlWoPRbk3noaO19yMuI8qAFHo/As4jykaRk1nEWOfRGLRh/cqNrA56qRQGPaAMDxQgZg1BxnMEl9E9jzNKvISnGvMsoewkxzm9vEzTEwejgzKDOSasTaV9t0GMxydPYSnSeMPmOPtfgkjGUD+LCDCJ8RByLSKqKvQhBNYvFDQhG6HAtNfQIEFrAvREjsmyVSzVNZYPGih4atkJ3dL+nThtv7lbI7c5L81UKvEnxM8rFhSHxfKIf7tqahMvRqPgdti/Hf92NRp8uniLOjJsNRiHp8o3ME93YV6DyoQm3zE0Tzwf6yli3RVyAPD1xejD4OZmcDUM3l4MB09Q74rZQG/v7UIslwY7a5k/G3a76kdbAg5AHl6Ng3dXt8PHUH9dJQn1/B47+pGSPNpStjLsbF97HaAdKucpuwGFic0ulJLqeQae2Ya7X9ABQwfD8cVo2H//yM4bidNliqOB3aNmdq+knRI1enqTVEsToPqxw6bneAsRL+0UI6XVYKq63gJLEW5H75de3TncTefw5q2qu82byDvnSvCwNqbmqhyV8DI1Wx0Ue+a6joVE1se+HOPIrYAwEsNQDrsXZmpnsR2DOIiXdu6tpu6NvbWa69m7HpOo7Hd4WA3XKfAY1I7K6/6YYXKQD9UDjX7slax/PWART1ON5HV3XZWojaJD/hR5Iq02YVKiGFVeYh/WXiI55J51I5y3Gs0dBMfH76WcUdRWW4dMY2J9c3zM/pAlIslZIvKYCcOmoKDHXnI2VZC8OtoXGjTbjWWkPWSB742pydI3GFHdKJTI0MghGvSqBvtTy9/AxQNqxd+PTfx5iyKOmOEK0+XVURCmPJ8dvf7YtM7RBUQvPf76S/4lH28QY7DSlIWAHaFQENEOwLA/vINQleTeJk4oXAfOG+ikGUa0VIAGc0N7GG5gc2CZmCjLhpEgV+RwbwWHgM4hYsgbpPQ/PVAJQe+6k1LEYF2wxxSBskkH2vTPX3+zjy32YcXILomRLHQw0oXUBsVTsOtswOVP1zvk03guNpX/fxfOOo8NfDcerkqYxgjGFueiLt/PTg/nG5bDFCHScVFVrcJxR9ffSlC0mN5titRWeCw0fcfr2X/QhJ9H9Tb6CzuEaFVu+YPtBbZZ0VCfYfHZ9XZ5h1R1/ZH26qGPxhdmi2WnTVKdr7vW5cWY9p2SzN4u8Zkt8frDruD74Dwu3xU2+l2eHGBZLKoGslyu6aungxzrFlNbThZgt/oXNy46sw== +sidebar_class_name: "get api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gives back an app your user has access to for the workspace. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-draft-version.ParamsDetails.json b/docs/release-management-api/apps/api-reference/get-draft-version.ParamsDetails.json new file mode 100644 index 00000000..5cf7393c --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-draft-version.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"app_id","in":"query","required":true,"description":"The uuidV4 identifier of the app.","schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-draft-version.RequestSchema.json b/docs/release-management-api/apps/api-reference/get-draft-version.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-draft-version.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-draft-version.StatusCodes.json b/docs/release-management-api/apps/api-reference/get-draft-version.StatusCodes.json new file mode 100644 index 00000000..daccf880 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-draft-version.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Gets the draft version","content":{"application/json":{"examples":{"200 - Gets the draft version":{"value":{"app_store_state":"REVIEW_SUBMISSION_STATUS_WAITING_FOR_REVIEW","version_string":"1.0.0","release_type":"MANUAL","phased_release_state":"INACTIVE","start_date":null,"total_pause_duration":0,"current_day_number":0,"app_version_id":null}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Draft version is not found","content":{"application/json":{"examples":{"404 - Draft version is not found":{"value":{"code":"ERR_NOT_FOUND","message":"Draft version not found on App Store."}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-draft-version.api.mdx b/docs/release-management-api/apps/api-reference/get-draft-version.api.mdx new file mode 100644 index 00000000..17d49f6f --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-draft-version.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-draft-version +title: "Get the App Store draft version" +description: "The draft version is the latest unreleased version—the one that can be submitted for App Store review. If no such version exists, a draft version can be created. - IOS only" +sidebar_label: "Get the App Store draft version" +hide_title: true +hide_table_of_contents: true +api: eJzVVttu4zYQ/RVCQJE28H2zKGDsBe7amwqbOKlvi3Y3EGhpHLGRSS1JOXGNAH3qBxT9wv2SzlCSHd8WzWPzoFgiZ+bMGfLMrLwITKhFaoWSXtsbxcAizWeWLUAb/MaEYRY/JtyCsSyTGhLgBqJyw9c//6F1JQH3cctCLtkUmMmmc2Et7pspzTppyoZWaWAaFgLua8yfMalwVxivI8GDMNZUGN9BUHgMNSCGqMaqzL8aYsBk6VU8lYLmBN6PEP452C7ZTnJTXDcQZlrYpdf+tPKsugPM8tPN403Fs/zW4G8PsSWwQejhUso1n4NFJ85M4gs652kaiAh9CmLqSwaaAGj4kgkNGN3qDCoH+MwyEU3OmIhAWjEToJmaOU7RYY0ghjHMuddGfMuUAhmrhbz1HgmlBpMqacDQeqvRoH/bITDnvERbrKHfUEmLIckCIyUidDzVfzdktvLggc8x89Ix0nrEE64veJJB4SgwRBM+sRoYftCb+L2PwXD806U/HPpX/WA46ozGw+Bjxx/5/fPg/dUgyDchpsJnUKTY9pq1Rq3haHTHKigouOz0x50L/J7GdNiCcrmM6vc770b+pEf0Wa5tELnvMksSrKyyPAlSnqFBlOXHw2s3kJFMa2QENy8Dmc2noN1nSqoEhgV2Xh7dX8U7azT3KR9LntlYafEHRM8jGt0h0Vv2T+kNVUTZ9QaDYNzvjEc/Xw3833pdjDEHY/gt7AbfwHyxD/Ma9FwYd4fw7InnY32BWPedHAF83RuUJ6Db6/s7qPfdbKCf7UPv7mqQVBaVJJPPzuEMc/iGtyPJ9K9GeHDH/e0ktv2snaAWbfSjtkms2dpPbGi5jLiOGMIGvNdsrR/Py6vZwryOOzuSFl7Nfrcz6AYX/rtef9jDi/nL2B/s1GoUI0VTkDATtnRpUJb3wpG0k14gcAkhib2TtJKAl4fkysccteQJG4JGJllPa6Wfl/xLp1aHHR1J3O+PeoO+U5RNnkOFIh+jDrF7jMzutXKqW6CnNUVN5RYsCRG3Mb7UCRxU8Vl1Okjv1eJEmLoTTtd1CFLePTKdoN1qivI1Hlw81gspq865RBhzjFxftMiNqS+aJJFcCz4tUi2schpnPEuQIC+2NjXtOtqI2lSgkhqoCeUd6j05EEZuGPph98LGrmSu6eSH9WbTJYfuq4tc9Mp1U8JgH2BZdr8YeAR6L+R1Z8TwJBDDesmsYijBrHPtYw9PEoPby1ZaKFguzcS2kDPlogmbuLaSs8Qu1yyRn00HwS2LVq25h+D09EKpO6ppeThVEpHp29NT9qvK3DQxE3hp8WzHoKHNXnEWa5i9PjlUGky7GqnQ1NEEHmqxnSdvsaKmlmoxxyT7mNDrAux3rcYGLr5gVHxOmvjooosThp0KD9Prk2CacHl38mbSdOSYFMJXdf7ms/wsRxvEWKwkocknglRDSMMPKc17mOqM6G3iPNZqtH6sIUl3NHHpYgRbYpoxXwCbi1vtzLASRIWEe+d4CjPlNoOsUdBvMpA7QXartzjIgKPgQCo41bkYmNPXv/5mkxa7LA3ZORlShh5WOlXGonsqdnEa1nPHZkzcnWW2irzaiMX/b2AtrpOFB1tPE463CTlxGrEqNOaTt6MxnhtR1ipDdDidwYsbI5lkscr1RePcQp/z4ZTUJxKGxAR1bMYTszufPmXy+0HRPH5g/2VqPZjHHSrEk0G5UGLPI40pdc3N35VSQQhjbtUJQ0jtE6u9NkBe1qp83hsRLxkx9lSk7pxIFT/c0F8syeVT31sCVAKn52PliMlqlUsgMlzuz5eOWqxFMt9NFN2g3v4L44mg3w== +sidebar_class_name: "get api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +The draft version is the latest unreleased version—the one that can be submitted for App Store review. If no such version exists, a draft version can be created. - IOS only + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-installable-artifact-status.ParamsDetails.json b/docs/release-management-api/apps/api-reference/get-installable-artifact-status.ParamsDetails.json new file mode 100644 index 00000000..71c8f711 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-installable-artifact-status.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier for the installable artifact.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-installable-artifact-status.RequestSchema.json b/docs/release-management-api/apps/api-reference/get-installable-artifact-status.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-installable-artifact-status.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-installable-artifact-status.StatusCodes.json b/docs/release-management-api/apps/api-reference/get-installable-artifact-status.StatusCodes.json new file mode 100644 index 00000000..1351ffe0 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-installable-artifact-status.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Gets installable artifact status with reason","content":{"application/json":{"examples":{"200 - Gets installable artifact status with reason":{"value":{"installable_artifact_id":"5738cc8d-8b88-4791-b023-13f7023def3f","status":"uploaded","status_reason":"Artifact uploaded, waiting for processing."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-installable-artifact-status.api.mdx b/docs/release-management-api/apps/api-reference/get-installable-artifact-status.api.mdx new file mode 100644 index 00000000..4b95f806 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-installable-artifact-status.api.mdx @@ -0,0 +1,74 @@ +--- +id: get-installable-artifact-status +title: "Get the status and reason of an installable artifact" +description: "Gets the processing and upload status of an installable artifact. Status can be one of:" +sidebar_label: "Get the status and reason of an installable artifact" +hide_title: true +hide_table_of_contents: true +api: eJztV+tuGkcUfpXRShWtxcXgRHZRLnIbJ0VNHAtfpDax0LB7gKmXme3MLA5F/O0D9BH7JP3O7C5ggy05v/ojlgx7mXPOd75zZREl5GKrMq+MjrrRO/JO+AmJzJqYnFN6LKRORJ6lRibCeelzJ8wID4XSuE1TOUxJSOvVSMa+Kc6LIzEODEkYjf9R97NuiFqhY2Dpz5ycp6TWFRcT5SqluBqrGUFMxjfidoIr6CgNT6SDOjxaSYuRsQHpLhh1Mcy9SFSia16MyZdqIDUn39xAs41CJyqWnpgF6R80sAZU6SlMauPZREUfJYWx1e1gJlN13+aUpN6wt8L6uGGXx6xzlKfpfG0vRCuoUp4plSJYXMt7w3HJXckgKZi0wK7SBIQ5bxX8QDIIvHTeWALlKUlH9z1R+o4vX+fEw7g5v+5Cr/Mr5BVzXLmgS/zsyg4ftCle7XDEkkzmA28GBdLtZDQavBYZCc52uVG6K6E6hjpOyjxUDBOQEPTOoY8yqBI/KaByJH7uNcVbIDo+66052lQIy7cqTeHZjONCwiFjo3pkMrKSneolRZ321oiOS/mi9nDYUZxb5edR99Mi8uaGUNufrpfX9cjLscN1tCEtKnEX4UAmrZySJ+uCsMYN7KkEWhV3iEz6Ca7vto0LjniukqtnQiWkoU6VQXmogNglrmVlCf54mxNQxxOayqgLyPOMrXIk9ThaMnBLLjPakeP3nf19/trRu3amWxnUW+QKkkA6HK9HsdEeUFmPzLKUqx56Wn/wWzyjL3KapStzoiGepB9SyN6c+GJDZlDJDBSH8fnhwVEcHyWNo+HRUePZ4Y/txnC/c9BoH4wO8Z3Q6GDE4Szi2o2qjFk9G1TmoiqIGw3pVirP6chxWPfzJvjkv3r0bL+9zeKllrmfGKv+CmaewBLUgaU78pssxCbhmJ70+4PL0+PLi18+9nu/n7yBjSmAyTHdN76GebAN84zsVMEflBYSTj0d6wGwbit5APDZSf9D7/y89/F08ObktHcP9baaCvrzXXnaA0qrZSrOyXKNn1hr7NPgPw8JuVvRAy70Ti9O+qfH7+8gPzco9QnnyC0si1trQrmV6Pmd4TTFBI3qReV3o9ZGOjdWnau1UMmy5dYNiBEVLSS3KcQWQ7Tey/77Zatsw42p1EAxheHWrNOCy641a0N2Jq1i5cHTUqpgcSTzFPxEE+8z121BRjWHRWNtKrOzKxVABKsR0FPUKDel0GwoFMP1umGeh6fBctk2V80Ixn6ledUGJxgfZLdMnh1foHNzpUk757mBKRV6fQzGmJiyn1ZpHkIcMdlKj0ywpnzKJ/oFS+LDiiXWw/SA18LYrNNsbyHY23tvzE1V9uypwVSE6Ou9PfGbycNmNsKaw9MUo5O64oUUE0ujl7VdoYHbjcTEDmFP6Etz4qfpa0TUNTOrpnDyFA69LMF+19lfw8UNrOLzqo2PN1BRE15a5NLL2mCYSn1Te3XVDuS4jOIXLfnqs/6sL9aIi0E4DLPUUhwGLGrsLQ1tzvS2nRed/c5hEyTdIKI5BnGYyHO4OZEzElM1tkEMkWAqNN0GxUMamXCYdJONPspAoQTsNsYYcRQo2OGKgm62AZ/+/fsfcdURHypB8Y4F2cMIkc6M81DPwS6zYbV1l4OEd6GisT+2at8P/WLdQb7t8d/2+G97/P9yjy+niacvvpWlEsMELSGMyEU5YT9FOycsZLtqvfnxrj5BJ+Hzi2K42nS55MeoLMur//V6loZBDEr5GhN9JFNHj7SP7/vlav6D+LrVfqeX1SDV8zDlw44S4fIGYzX8xFhe41Q5WRlw8eIY9ZH5DZGt7Ygn+GpZeXdygbM8YO8O75swvMuL8LtoF5y7g7nCxp/L+gMii0WxGoD86nzx6kGJ1fJQes4eYA/5DwPMLPo= +sidebar_class_name: "get api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gets the processing and upload status of an installable artifact. Status can be one of: +- 'upload_requested': This status is given back when an upload has been requested for the installable artifact, but didn't get uploaded yet. +- 'uploaded': This status indicates that the installable artifact has been uploaded, but not yet processed. +- 'processed_valid': This status means that the uploaded installable artifact has been successfully processed and that it is a valid artifact to be used for either build distribution or store release. +- 'processed_invalid': This means that the uploaded installable artifact has been processed and that it is an invalid artifact, it cannot be used neither for build distribution nor for store release. +- 'ready_to_upload': This status is only given to installable artifacts that are created using the deploy step on Bitrise CI. For API uploaded artifacts this will never be set. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-installable-artifact.ParamsDetails.json b/docs/release-management-api/apps/api-reference/get-installable-artifact.ParamsDetails.json new file mode 100644 index 00000000..b5d02268 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-installable-artifact.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the installable artifact.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-installable-artifact.RequestSchema.json b/docs/release-management-api/apps/api-reference/get-installable-artifact.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-installable-artifact.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-installable-artifact.StatusCodes.json b/docs/release-management-api/apps/api-reference/get-installable-artifact.StatusCodes.json new file mode 100644 index 00000000..11de8f44 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-installable-artifact.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Installable artifact","content":{"application/json":{"examples":{"200 - Installable artifact":{"value":{"app_name":"No Title Found","branch":"master","build_number":"112","build_slug":"build-slug","connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","created_at":"2025-02-11T09:26:01.000Z","distribution_ready":false,"download_path_or_url":"dummy-download-path","filename":"MyInstallableArtifact-115","filename_ext":".ipa","formatted_version":"1.0 (1)","id":"installable-artifact-slug-119","is_processed":true,"platform":"ios","project_id":"de351d6f-1324-4a9f-a23b-21faa2d03d5c","public_page_token":null,"signature":"unknown","source":"ci","store_app_id":"com.no.store.app.id","store_signed":null,"type":"ipa","uid":"5738cc8d-8b88-4791-b023-13f7023def3f","version":"1.0","version_code":"1","workflow":"primary","download_url":"some-download-url","file_size_bytes":0,"public_install_page_url":null,"min_os_version":null,"device_family_list":null,"export_method":null,"certificate_expires_at":null,"test_devices":null,"supported_device_types":[],"is_test_install_enabled":null}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Not found","content":{"application/json":{"examples":{"404 - Not found":{"value":{"code":"ERR_NOT_FOUND","message":"The installable artifact cannot be found."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-installable-artifact.api.mdx b/docs/release-management-api/apps/api-reference/get-installable-artifact.api.mdx new file mode 100644 index 00000000..c31ab478 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-installable-artifact.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-installable-artifact +title: "Get an installable artifact" +description: "Returns the details of a single installable artifact." +sidebar_label: "Get an installable artifact" +hide_title: true +hide_table_of_contents: true +api: eJydV21v2kgQ/isrS6e0VcyLIU1AfVGkpj10DakIiXRNI2ttj2Ebe9fdXZNwiK/3A+4n3i+5mbWB0MBJaT4QvN6ZeeaZVxZeAibWorBCSa/vjcCWWhpmp8ASsFxkhqmUcWaEnGTAhDSWZxmP8DvXVqQ8tg3v0FMFaE46Bglq+QR2sLl4Wt/DawbiUgs79/o3C8+qO0CbN7fL20PP8onB794jObYSNB5eKLjmOVjQxglLfEBLIkGtgpAX3E7x+7Y7Y3SjLEVy3WUiAYnqBGhyiPzb54uGH6XQgI5YXQKCjqeQc6+PiOcFGTVWIxveknBrMIWSBgy9D1ot+reNYbDDDFqJlbSIiO7zoshE7OhrfjcktPDggedFtlbLfLZTD76d8ayEWk1Y0zJUbCwsXvyoSkkURZrLeIpvcm6QQzopRZaEsswjfOx77XawPjRZOcEj9+C7BwdXQmwhCcmMoCinnSROW72u3+1By++mUc+PXkddP46D4LiXBlEnAZLUwJ0cokVXgiO/Ffjt9rjV6wev+612o9VqfaXICeI1KomGEGUSzJKUZwYjkKh7mSmehBTkUOmw1BkqS8o8n/url36dAanIoKbhfL4jDdH20aNrITwQsIYoOJ0qnXNLcGeYaVUAESF70X5JiUZuP0obfxUHxxIq7tElExZaxWDMJoWKjFtSTeLK4CW88R3prIhMoHPUTl6nfrsTIJu8l/o86ER+0E45D5JWJzmKSaaMME2QgwmEde3IMsswQcVEcqxbcrmUdxIJoVpTpY7pKBb0ZJWGTexilTekarjTBp42XCFVl0gdQa+U1zlf0VM64aPjzkkcnyT+SXRy4nePe20/agUdhJ8e4/8E0k6Kl7cY3DyHsUpIYxuP7pW+SzN1T/WrRc713HsU7SrKRuWwCTKdVcFDnH9BGM0tFUlrTU8dnoomp6HyIxcyVGYT1uo0gZmIIUx5LrJ5mGEKrt7AQ6G0DbHlTNWajBgo4FSrlDcFdgnj8rqmCowNK41mHZuyID2YULUp4pNa2K3LFCeygoz5iElVG1u6v0Ov22o/7SlXkpeISyMDyfN6CarDXrIl/7iH1LE5G43Cq+Hp1fj3i9Hg69kHtJFjQiOlPxvfwOw8hfkFdC4M8Y3DRIrnY+0g1qdK9gD+cjY6H1xeDi6G4Yez4eAn1E/VbKB3n0IfKsvSunk+C3IXIW+E90AdXozDjxdXw22I4z1DicVcSlQZQaW1sYZ+tHvgYIeXPGOXoDHd2ZnWSj/PjaN64uxStMelwXB8Nhqeft7y6FJR/eCwZPdomd1r5eZmjX5VW94EaCK6/t33mrsarGkuRLJ0GwRBqXaAqj8sIm7gavR52dSQAX73cy7RfI4Wm7Ogib6a5oy6zYxrQVqdi7VURV/Ky4ymwNTawvSbKCMakcBxZKAh1M61ogLCSA1DPexe2KlbK9y6AC5Gt5uN59KdOst1716vE2jsD5iv9pgpTj43oH8qpdMxwwFMzOo5s4qVaPf0ywBzI8tootQjb1WaLrYesSxkqpw1WgjciudYYudrlkjPVr+eBY32EwSvXn1W6o5iiZPMeaqyhETfv3rF/lQlZSlLhUyYsGwKGvrsDWdTDenbg12hQbexrccG453AQ2Nq8+w9RtQ06kkwRIfe1mB/C1obuPiAVvHzuo0fH1DFAbNcYxK9PQijjMu7g3fXbUeOKSB+0+TvvslvcrxBjMHKMiqnBAoN1M0Thn3hI0S6JHrbxjLcVI4bSNIdRhRHKzrMLZujm1M+A5aLiXZiGAmiQsK9UxwBkkOXQTbI6P8yUClBdv0JDlZwFOxwRaBusoE+/fv3P+w6YOcrQfaJBMlDDyNdKGNRPQW7zgZcxA3DsOxbdbcivNh0iF/+HVCntMWlqolLD2Y04nJ1uqjr+2bnAkUZ3MflAitmqmgI33iLqrA1TkI6/lGCnldzc1XHrgng2lhPzdWyuM+nF6N6sX/Jful3wU7fVjUs567BuL7o4dc7rGj382R5i7fqoia81YvTOIbCPhJ50pGpeawb5KezMd6l2t7uG3eub9Rf3G+qXXC2e8IKG30uD/eILBZVV1ou1/erV3sl1n2r9pw8wBb4H3NC6qE= +sidebar_class_name: "get api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Returns the details of a single installable artifact. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-outgoing-webhook.ParamsDetails.json b/docs/release-management-api/apps/api-reference/get-outgoing-webhook.ParamsDetails.json new file mode 100644 index 00000000..ce796799 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-outgoing-webhook.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the outgoing webhook.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-outgoing-webhook.RequestSchema.json b/docs/release-management-api/apps/api-reference/get-outgoing-webhook.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-outgoing-webhook.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-outgoing-webhook.StatusCodes.json b/docs/release-management-api/apps/api-reference/get-outgoing-webhook.StatusCodes.json new file mode 100644 index 00000000..c8d8389e --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-outgoing-webhook.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Gets outgoing webhook","content":{"application/json":{"examples":{"200 - Gets outgoing webhook":{"value":{"id":"75be346f-2e70-44c9-95af-7dc7c8f0c48e","created_at":"2024-05-09T15:52:21.000Z","events":["release_candidate_set"],"all_events":false,"webhook_configuration_id":"5623239f-28ea-4b8d-856e-8cb50073fade"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-outgoing-webhook.api.mdx b/docs/release-management-api/apps/api-reference/get-outgoing-webhook.api.mdx new file mode 100644 index 00000000..62d42ac0 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-outgoing-webhook.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-outgoing-webhook +title: "Get an outgoing webhook" +description: "Gets an outgoing webhook." +sidebar_label: "Get an outgoing webhook" +hide_title: true +hide_table_of_contents: true +api: eJyVVu1u4kYUfZWRpSptFINxIB9oP4QamqImbAokVXc3QoN9jacY2zszJpsi/vYB+oh9kp4ZG7IJsFLywxkz9+Pcc+ee8dIJSQVS5FpkqdN2LkkrxlOWFXqaiXTKHmgSZ9ms5hw5WU6SG7teWFp+qIz+KG1goigopNCPTvvT0tHZjBDz0/3q/sjRfKqwdtY+rHJSDjZzLvmcNEllHVO8IIMIEVEYVDnXMdbPoY5iYkUhwrsmEyGlWkSCJMsiprGxC7+kL4WQBPBaFgSwQUxz7rSB9DE3CZWWcHFWBq8klWepImX2fc8z/3ZQ9TIP0gRZqgHHOPA8T0RgOav/pYzX0qGvfJ4nm7jMZbsDYXvBk4LMQhjCT1sTOm6eRK5Pp57bbAbn7nmLR+5pGJwGZ5EXNM/IpJfENYVjDgRI4Dddr+V656NGq93y236j5nneR9jRAiBtSyQlxBWNA56GIoTzWJE2beFJMl6bRTxR4KxCN0aRkZgW5XkYW3ytE//YPz4HvjPibnNyFrpnrRNyz4JJy/NOjyMeErg1f0dO02tsM3qb8kLHmRR/U/g6IhEORD7z/5a/IAtNf7uDwfi237kd/fph0PvYvUCOOSnFp/Qy+RPM422YNyTnQim8MJw78Xqsx8C6HWQP4Jvu4Lo3HPY+9McX3X7vBertMBvoDX8b+lCjx1yGDAgJp5ttZuJ1JTR8lLA/2J5ShqNO/6IzuBhf9X7u9ofd8aD7+21v8KKkUSwUm1BKkdDrkNCk7XRRJu2sA3hKAc48A+7ahoDWrqHtoUaZ8oQNSS4gF10pM/m64lt2aHcH2lN4rz/qDvqdq2d1DjNIXlyOfKrZg8ys9lTozV5mxmqKWTwqFbDt1Ncy4VaDqOpLEa6s8hoYpX4WMoHtcoKhvh1crerVgLtzniL1HNnqC7+OOlV90YDvgkvBJ1V5lVdJXcSLxOhIrHWu2nX4iNpEQCYV1US2U5JLIMyEYYjDHoSObZus3JLtz/3TTTG0v9rM1X2xkWMk+40e13dATNAPuZXypjNi6L5hVT4ynbECeTs3PRZAvRTMq8tkPdy2r45hWKRRZrMJnRiLQckSu96wZOIYesBrmWzh1xpbCA4Pr9AI08f1gcyS0Li+Pzxkf2YFkKQsEmnIcJ5jktRmbziLJUVvD3a1BmW7YRaoOlzoay3W8+Q9OqpquRRzFNlHQW8rsD/43hNcvCArnncNPC4Q4oBpLnGA3h6MJwlPZwfv7hqWHJVT8KbO331OP6ejJ8RoVpJg9qAluaTA3CMMyvILTWRh6G0ozXClnNZA0gwdLSShYK7ZI8qM+YLYXEyldUMnDBUpPdjAEwI5xpjSmkn6XQbKIGDXneJ+J0vBjlIEYpscqOm/f/5ldz67XjuyS+NoKnTQ6TxTGuFNs6vTsO8z52Vzl0/C8N1Po+rEavqq63nCcWCR1o7hshrdT87W6MKvjZsTwxADoDFZljMrk9XK/PylIGk+pe6fRtTOdyiUWYebW3kv5h8HlST/xF79ubSzpvVopo9WN6zUOVjOMKj2i211D6tqVg3WcqMTBJTrb1y2RNZowkbzLrsj2JqRfS4HMysH1cJ+Yu6C83zU19jMc3W0x2W5LMVmtdrYl1t7PTZyVFVuKoCy/Q8d19jF +sidebar_class_name: "get api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gets an outgoing webhook. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-presets-list.ParamsDetails.json b/docs/release-management-api/apps/api-reference/get-presets-list.ParamsDetails.json new file mode 100644 index 00000000..0a6826be --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-presets-list.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"app_id","in":"query","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-presets-list.RequestSchema.json b/docs/release-management-api/apps/api-reference/get-presets-list.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-presets-list.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-presets-list.StatusCodes.json b/docs/release-management-api/apps/api-reference/get-presets-list.StatusCodes.json new file mode 100644 index 00000000..7a29c917 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-presets-list.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Presets","content":{"application/json":{"examples":{"200 - Presets":{"value":{"items":[{"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","id":"157f4a5a-edb4-49a3-ab0b-ef0a865ef821","template_name":"","default":false,"description":"","auto_upload":true,"approvals":[{"summary":"qa-check","description":"After quality assurance has finished testing, check back here."},{"summary":"security-check","description":"Everything is adhering to our security policies."}],"notifications":{"slack_webhook_url":"https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX","teams_webhook_url":"https://outlook.office.com/webhookb2/valid","slack_notification_integration_id":"ceec9565-0de0-4603-92b2-255e42c2d203"},"automation":[{"event_name":"release_candidate_set","workflow_name":"google-ser-cred-test"},{"event_name":"approvals_completed","pipeline_name":"notify-stakeholders"}],"release_notes":[{"locale":"en-GB","whats_new":"What is new in english"},{"locale":"hu","whats_new":"What is new in hungarian"}],"default_release_method":"phased","app_store_release_type":"MANUAL","outgoing_webhooks":null,"release_candidate":{"branch":"main","workflow":"build-new-app-version","source":"ci","auto_select":true}},{"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","id":"ed81ff4b-e4d8-4f29-a442-386706a41a93","template_name":"","default":false,"description":"","auto_upload":true,"approvals":[{"summary":"qa-check","description":"After quality assurance has finished testing, check back here."},{"summary":"security-check","description":"Everything is adhering to our security policies."}],"notifications":{"slack_webhook_url":"https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX","teams_webhook_url":"https://outlook.office.com/webhookb2/valid","slack_notification_integration_id":"ceec9565-0de0-4603-92b2-255e42c2d203"},"automation":[{"event_name":"release_candidate_set","workflow_name":"google-ser-cred-test"},{"event_name":"approvals_completed","pipeline_name":"notify-stakeholders"}],"release_notes":[{"locale":"en-GB","whats_new":"What is new in english"},{"locale":"hu","whats_new":"What is new in hungarian"}],"default_release_method":"phased","app_store_release_type":"MANUAL","outgoing_webhooks":null,"release_candidate":{"branch":"main","workflow":"build-new-app-version","source":"ci","auto_select":true}}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-presets-list.api.mdx b/docs/release-management-api/apps/api-reference/get-presets-list.api.mdx new file mode 100644 index 00000000..40c9a905 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-presets-list.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-presets-list +title: "Get a list of preset templates" +description: "Gets a list of preset templates for the app." +sidebar_label: "Get a list of preset templates" +hide_title: true +hide_table_of_contents: true +api: eJztWOtu28gVfpUBgSJtYOpCS45tbHbhrdVUqONNZTm9ZANhSB6KU1EcZmZoxyv47z5AH7FP0u8MSfkiewujf6MfFDk898s3Z7gJUrKJUZVTugyOg3fkrJCiUNYJnYnKkCUnHK2rQjqyItNGuJyErKpesBfoioxk1mnaMH/wDPYM/HhtKamNcjfB8adN4PSKoOLT59vPe4GTS4v7oKUPsFRJI9fkyFhPXuIBMqFooVLIUmzel5rMDR4MfamVISh1piYoSnJay+AYWm4qZrPOqHIZ3LIuqKh0acny+2gw4L+HXndW7AWJLh2VjkmguVCJ967/L8t0m4C+SkRiK0mEomPFwpUsauIbhXg1TkBcSYmjdNH6cRxk+2mSDY5G4eiIBuEoi4/C+CAehUkSRW+OsijeT4ndZdrh+E02kmMZUhozg9wPZTyIQ8oG8vBgTNlhNARtl55FGzMspZTJuoAfmSws7T3yFwSydnpRV4WW2yDCRKPhRGO6rddriWAj6DJEeJNV8FjMSYZsiS+1LJBjIa2tjSwTErlEoahS2ZxS1I51SMWe8DJELHHJyVAvuN27r6WrlWd0Ta6QeZdDklCo0BQi+N5poWsjOmZRaeRMkYV0ZL7UTmVtDn2KbAH1i2uKc61Xi9oUkJw7V9njfp+XbM9T9BK97lsyVyoh258P2l//x+3d35/5+WzItX1Gh65dgdWezmAWeTUtYRz1EXpf6Y2R921fKFTl0rT3XBkJUXI0PhiHg5Sr6GCwHx5FcRRG4zGNoiRKo8E+AuzTvJZNDJFUukJxd2ViqCBpaZHIMlUp1w8qGfqvtVllhb7u6JZaLwsKEY8wQc+FnFGfvAfSttWzgFfoERQ9ZFWqokKV29L0Xt2E1skV5bpIudubHm1swXtq6q/QiSyYhcrw3Y9sVi6dXZR0jbW/4Z7rAE9ClYLKJRAr90Zt+fL6t5nyulxKo2TpDWgbZtEZAiTKNUe6QjV7V7iDrdOGtjQt1rw/Ob88OWM0rN1Soyq75MORsi6Kvd1Icy3G3Cw5+NcS2HYXdqzEtSrSEHaGUBqi8i0nEJWBWk9YZaK6FrYQnbimhW/Z//8Tcig9HGbZCBgzSg9BGx2FcjSKwv3DgzeDAzkayqP9b5DzDXK+Qc43yPGQ8/nW//aC0WC4O1ldlmDJtVG/eIdeMF5BHMarB/z3Z6xEp2zVZDZbXJ6fXM7//NNs+s/JKXSsyVq5pMfK78zcf2IAJLNWll0WKZXq5bbu8yi4I+QZgz9MZu+nFxfTn84Xp5Pz6SOrd8VsTR9Gu6ZfOGRYmhQze0KYcsV2Nn6ZC8MILjwv7BlXLuYn56cns9PF2fSPk/OLyWI2+evldPbIpXmOHoippEy5TiQfM3bUdceL7SbWHDS6AIyfGt6n8NGUshAXQE9sDhNjtHmZ82M/yj8t6BnHp+fzyezc9+Cdnxeae5g3iWtoFtdG+zNIa/22v5ce8yrpuBX71fbwYb3eBosaEN/E6OHL2dltv+3ncC1L6FpDfP8q6sMx27/iM8AV40rc+tNyNbFqd+XthiAr1YsVzkeWekrv7HpzhL8xRLAYATniWrnc58Wfs8gn5PPd8e7Cr3rN7SFvew6Dsr/QTXd8y0kCfndUfjiZAyETDqO54f21ht6TD1MBWC04MB3et93cbC4cUlVm2mtTzgPwrImSeL+NEsvh8LSAdhxcRb3hjgWvX58BPDlxXQVio2DWH16/Fv/QNSwpeb5IBQqYR4lj8Z0UuaHs7aunUgO3w1Qntg8W+trL3br4ARm1vcooHj7O4dDb1tjfRYM7c/EArbh+HOJyChGvhJMGFfP21SIuZLl69f3HoQ+OrSj5ri+//7n8uZzfWYxkFQWaDeCBykLRo4kAJX+i2NQc3iFO9tEgetNDkFbIaG0IDmObuoGbubwisVa87/McpX0oePNiwTEhOExMZY+V/mYEGiGIbrisVUo+BE+4oiCbdcCn//z6b/ExEu87RvGOGdlDnioqbR3Ec7Lbavgfnyoe53hzBwgv/crR1rKjr64PCpQyDPINumm7+FNQ3X3IyGEqL22a7jXF7S0vN98uuLdTZblV06dH5fuG/n7W4u8fxHN2rOjm/meSFqsCP2F0oOC/uux17ccmNFwnSUKVu8e1A5QsZYtb7ybzZgbIH3b4ynd4e+M/9bSvypv7sh90b2c4X3mGepJls2nwAwHs6JtXz3JsEaah5hDxgPJfQ55/4A== +sidebar_class_name: "get api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gets a list of preset templates for the app. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-presets.ParamsDetails.json b/docs/release-management-api/apps/api-reference/get-presets.ParamsDetails.json new file mode 100644 index 00000000..cd2bbaec --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-presets.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the preset template.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-presets.RequestSchema.json b/docs/release-management-api/apps/api-reference/get-presets.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-presets.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-presets.StatusCodes.json b/docs/release-management-api/apps/api-reference/get-presets.StatusCodes.json new file mode 100644 index 00000000..c25b00d3 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-presets.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Presets","content":{"application/json":{"examples":{"200 - Presets":{"value":{"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","id":"ed81ff4b-e4d8-4f29-a442-386706a41a93","template_name":"","default":false,"description":"","auto_upload":true,"approvals":[{"summary":"qa-check","description":"After quality assurance has finished testing, check back here."},{"summary":"security-check","description":"Everything is adhering to our security policies."}],"notifications":{"slack_webhook_url":"https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX","teams_webhook_url":"https://outlook.office.com/webhookb2/valid","slack_notification_integration_id":"ceec9565-0de0-4603-92b2-255e42c2d203"},"automation":[{"event_name":"release_candidate_set","workflow_name":"google-ser-cred-test"},{"event_name":"approvals_completed","pipeline_name":"notify-stakeholders"}],"release_notes":[{"locale":"en-GB","whats_new":"What is new in english"},{"locale":"hu","whats_new":"What is new in hungarian"}],"default_release_method":"phased","app_store_release_type":"MANUAL","outgoing_webhooks":[{"all_events":true,"webhook_configuration_id":"b203f887-05e7-4ac2-a4b7-13ce0a02316e"},{"events":["release_created","release_candidate_set"],"all_events":false,"webhook_configuration_id":"7613aaac-5822-4b83-8050-7c4a273b6d56"}],"release_candidate":{"branch":"main","workflow":"build-new-app-version","source":"ci","auto_select":true}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-presets.api.mdx b/docs/release-management-api/apps/api-reference/get-presets.api.mdx new file mode 100644 index 00000000..e4db984a --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-presets.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-presets +title: "Get a preset template" +description: "Gets a preset template for the app." +sidebar_label: "Get a preset template" +hide_title: true +hide_table_of_contents: true +api: eJyVV+tu28oRfpUFgSJtYEoUdbONk3OgU6up0EQnleX0kmMQS3Io7hHFZXaXclRBf/sAfcQ+SWeWF9mWHNT6IVHkzsw331y5d2LQkRKFETJ3rp33YDTjrFCgwTADmyLjBlgiFTMpMF4UHefCkQUoThKzuJL5ZM9rfKQhKpUwO+f6y94xcg2o9cv94f7CMXyl8dppzuKtgiu+AQNK2+M5/kF9IkY9gtAU3KR4/RTiEnGUpYg/D5iIITciEaCYTCzAZ8AJrIKvpVCASI0qARFGKWy4c43wdgXZ00aJfOUcCCSKFzLXoOm573n089T80dVI5gbt0xHkJRORpaT7m6Zzewe+cQTRamIua0TxxpZnJdAFKskhMhAHqCMQxGfSj6PEuxq4gyvw3EESXrnhKBy4UeT746vED/sxEEN0FuLLXpIMQhcG8SWe9a9cPhj4bv9yNPZGfNDjV3082/AR1BRbUhNeZog+4ZmG5yTjAV4aGZRFJnlLHUJUEqFX4dLlZsMVRtr5yl0kNVqfxGqSYHDZ15JnmBKMa10qnkfAUq5ZInKhU4gxWNpgAC6Y1cFCjl8pKAze4eKxlSa1XrA13YLamRQ1MYE5HKMKujaSyVKxRpgVEiMlQKN2jHcuKX+qyNnA6AzNBw8QplKug1JlqDk1ptDX3S7d0h17ohPJTVeD2ooIdHfp1Z/uz+3V31/42GjwjX7BhixNhnc7MkFYYM3UB0O/i9Tb4qhAPsYeCMzFlaqvKTMigOhqOBq6XkxZNPL67pUf+q4/HMLAj/zY9/pIsA3zhlccYlBhiyndpImCDLiGIOJ5LGLKH8xftP8g1TrJ5ENzbiXlKgMX+XAjrDSXImqD90Rbmz0BeoWVgUmPugpRQCbyNjWtVztXG76GVGYxNYeqMiss+Byq/MtkxDMSgdx9/zPBSrnRQQ4PeO9veE15gP+YyBnkqwyzzYJq5dLy+0Jpma+4Ejy3AOqCCRog2LhSSUwXmM3WFapgbaSC9kzdYT5O5neTD9Q4S7OSmJVN8CtHeJYFlindFFqTG9gdErEqH8c1xLgll5dj1xvC2B3wyMeKD8durx+Bxz2/3xvBkXvbcdswKuAV6ecDi04+hlI3hu9gGY96fc555A4vfd8dhJd999Ibeu44GnB/3A9H8XD0JHitPSq1kHpBimo2HLv9MavIyVJksYthcJFTFwtbU35i4mMpR8RoJJoOpVF1ZCriDtXnwhl4vdPOfZejQCqV+Jfl4BXtG9Vh+34i/7SHx4RpulgEd/PJ3fLPvyxm/5zeoI0NaM1X8Nz4EWb/zIABtRGaHGY43sTrsfZp1JwoeQHwp+ni4+z2dvbLPLiZzmfPUJ+qaaH3/FPotwbjy1XMECHgFGXt7H2dCz0fXXhZ2Quu3C4n85vJ4ib4MPvjdH47DRbTv97NFs9cWqZY4CHkkAjTqKSV58Rcs/O0E7rafhoChueWgxn6qHKesVscDTj5pkpJ9Trnh3ZVOK/oBcdn8+V0MbcN5ujnraQGRRPwAS2zByXtjlOjb5vXyjZ0u2hdO91qfdLdvYgPdpkj41WTqsbUPsQyvlt8OHTrknY3PEeDG7TR3fpd9E53tz2U3VLnDGunaqmKsHrvaEceL0QnFLiEaegIeXbfq4AwUsNQD3sQJrXBscsc2KjcH5fPW3vXWq5X0HbZQ2N/gV2zYKbAccCcmPw0WeIMiIhLtaMNokS7k08zhoMjo9WvmWh1SVfjk3gVeSKtNWHsiFlULLGPLUukh+ipe9q1s/U7vRMEb99+wJ5L0WvSEEchif709i37hywRSU4bVMwwi2lZumY/cJYqSN69ORcadNuNZaS7KALfOqnZZD9hRHWnUILWqzk69K4G+zvfO8LFP2gVvz/38OsGVbxhhitMm3dvgjDj+frNj597lhxdQPRDl//4a/5rvjwixmBlGVYcdhBMr4gmEMN+8icIVUn09rRhvuePO0jSGiNaKkCHcRDv0M2Ub4FtBG02tClKSwWNZ1IcApJDhyHvkNHvMlApQXbdFb48gKXgjCsCdZMN9Om///4P++yzj40ge0+C5CHtTYXUBtVTsOtsOP/u9Dy0+2Mz+D/fturMNfDNdPEAJi6at+W4rwv3i1O0byXXOJmxFFKERw/2VcWq7HCg219LoF36y/2xQG11x0LTdXz+deAx5t8v6jb8B/baN7GzjjR1me9s07DdjV4/1rCr3gUP93iqLlSCWj2YRBEU5pHISV+lhtC2uffTZbUwpE97wdr2gvrCvrKeg/O0zhts9E2L1lmR/b7qNIdDe7569KJE24tqz8kDbGv/A7oyWQo= +sidebar_class_name: "get api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gets a preset template for the app. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-public-asset-status.ParamsDetails.json b/docs/release-management-api/apps/api-reference/get-public-asset-status.ParamsDetails.json new file mode 100644 index 00000000..acfca9b6 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-public-asset-status.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier for the public asset.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-public-asset-status.RequestSchema.json b/docs/release-management-api/apps/api-reference/get-public-asset-status.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-public-asset-status.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-public-asset-status.StatusCodes.json b/docs/release-management-api/apps/api-reference/get-public-asset-status.StatusCodes.json new file mode 100644 index 00000000..f40a2234 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-public-asset-status.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Gets public asset status with reason","content":{"application/json":{"examples":{"200 - Gets public asset status with reason":{"value":{"public_asset_id":"dd6fadd2-6e4b-4bda-b6e2-aa319cdc89cd","status":"processed_valid","status_reason":"The asset has been processed and ready to be used."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-public-asset-status.api.mdx b/docs/release-management-api/apps/api-reference/get-public-asset-status.api.mdx new file mode 100644 index 00000000..e8f1cdd3 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-public-asset-status.api.mdx @@ -0,0 +1,74 @@ +--- +id: get-public-asset-status +title: "Get the status and reason of a public asset" +description: "Gets the processing and upload status of a public asset. Status can be one of:" +sidebar_label: "Get the status and reason of a public asset" +hide_title: true +hide_table_of_contents: true +api: eJztV9tuGzcQ/RVigUKtoYutOGkrJCncxkmFJo4hX4A2MQRqdySxXpFbkitHFfTaD+gn9kt6hlzdLDmoX/oUA16vRM7MmTNXz5OMXGpV4ZXRSSd5Q94JPyZRWJOSc0qPhNSZKIvcyEw4L33phBkKKYpykKtUSOfIN8VFPEmlFgMSRuN32PmoG6IWRfuW/ijJecpqHXE5Vm6pC28jNSWIyfRW3I3xBh2VvbF0UIevVtJiaGwEuGG+LgalF5nKdM2LEflKHLdnwLaBYte6zlQqPbHT0u8oXgNYykdT2nhWvWSJsmhk9bE/lbm6b2tCUm/YWWHcb9CVKesalnk+W9sJwQgqlGfqpAiWhLReDWUKzYb5L13FFCmYssCs8gwEOW8V8CPWAofOG0ugNifp6L4HSm/58DjwD+PVolK8glznI+QNc7qErivc7MIe7NrEoz0OWJLZrO9NPyLcTTajwWfMOHC1Cb9yT0JlCjWcbGUoAHY4I+ibQQ8VUCF+VEDjSPzUbYrXQHJy3l1zsvSMFcLincpzeDTlOJDgaknqiSnISnamm8WyOw9IThhIrCVccpSWVvlZ0vkwT7y5JZToh5vFTT3xcuTwnkQpEcRcgoNCWjkhT9YFIY0P0K8yaFNc4IX0Y7xvV/0lR7RU2fWxUBlpoFcV+fcLgqFzLSpLwO1tSUCZjmkikw4gzgq2xpHSo2TBQC25wmhHjs/bh4f8Z0/L2UqjKlh3yAEEVzpcqyep0R7QWF4WRc5VC/nW73yK7+iTnBT5yoxoiP+kF7eRjSXxS7zbD3f7isOSZc+GMsvajWd0PGgcDzLZGDyjdkPKJ0ffp1n6HR4cphgvkLtd/6uj/tJaYPqztRLyd6OKm6CRf+rJ8eHRLnlXWpZ+bKz6k7LHkQR1IGlLfpOM1GQcytNer391dnJ1+fP7Xve301ewMQFYOaL7xtcwn+zCPCc7UZgmqBzkl3o81ifAuqvkAcDnp7133YuL7vuz/qvTs+491LtqltCf7kvPLlBaLXNxQZZL+NRaYx8H/2nIx/2KHnChe3Z52js7ebuF/MKgssfcke5gWdxZE6qsQs9nhrMWAzCpx0LvJK2Y1Y3Y4VpzlS1abt1fGEnsFKXNcX0+QCe96r1dtKqu2phIDesTGGxN2y246lrTI8hOpVVyUHlYSUX2hrLMwUsy9r5wnRZkVHMQ+2VTmb3NJwIRrEZATyxR7j2ht1Aogpt1P7wI3wbLVVdc9R4Y+4Vmy243RjWR3TF5fnKJhsxVJ20oNlRaaOGpzHMmpmqby/QOoU2YZKWHJlhTPucbvciSeLdiifUwPeA1Gpu2m0c7CA4O3hpzy6FcdlmDIQfRHw4OxK+mDIvUENsJD0dMQuqI51KMLQ1f1PaFBm43MpO6FkToU3PsJ/kPiKhrFlZN4OQZHHpRgf2qfbiGiw+wiuf1ER6voKImvLTIoRe1/iCX+rb28vookOMKSp+35MuP+qO+XCOO820QRqSlNMxN1NZrGtiS6T1yXrQP2982QdItIlpivoZBO4ObYzklMVEjG8QQCaZC011QPKChCZdJN9noZxmISsBuY4RJRoGCPa4o6GYb8Omfv/4W123xbiko3rAge5gg0oVxHuo52FU2rHbjao5U7drxMrWzEN+P+HzdML4s2V+W7C9L9v+xZFczwdMn3ypyiZGAwg6Dbl7Nxw/J1nyETGdjb+OFeow+wPfmcTTafLHgr1Eplvfym/UkDGMUFPI75vBQ5o4+0wW+7lV79Dficfv3Xq+W40/PwmwOG0WC11sMw7D/L25wq5qHDDQenCD/C78hsrPL8NxdrRZvTi9xl8fi9si9DSO3egn/rOyDsz1Ol9j4uag/IDKfx4EO0pf349GDEquRX3nOHmB7+BeYM+tf +sidebar_class_name: "get api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gets the processing and upload status of a public asset. Status can be one of: +- 'upload_requested': This status is given back when an upload has been requested for the public asset, but didn't get uploaded yet. +- 'uploaded': This status indicates that the public asset has been uploaded, but not yet processed. +- 'processed_valid': This status means that the uploaded public asset has been successfully processed and that it is a valid artifact to be used for either build distribution or store release. +- 'processed_invalid': This means that the uploaded public asset has been processed and that it is an invalid artifact, it cannot be used neither for build distribution nor for store release. +- 'ready_to_upload': This status is only given to public assets that are created using the deploy step on Bitrise CI. For API uploaded artifacts this will never be set. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-what-to-test.ParamsDetails.json b/docs/release-management-api/apps/api-reference/get-what-to-test.ParamsDetails.json new file mode 100644 index 00000000..71c8f711 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-what-to-test.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier for the installable artifact.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-what-to-test.RequestSchema.json b/docs/release-management-api/apps/api-reference/get-what-to-test.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-what-to-test.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-what-to-test.StatusCodes.json b/docs/release-management-api/apps/api-reference/get-what-to-test.StatusCodes.json new file mode 100644 index 00000000..4eac9819 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-what-to-test.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"What to test does not exist","content":{"application/json":{"examples":{"200 - What to test":{"value":{"what_to_test":"Test the new feature"}},"200 - What to test does not exist":{"value":{"what_to_test":null}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/get-what-to-test.api.mdx b/docs/release-management-api/apps/api-reference/get-what-to-test.api.mdx new file mode 100644 index 00000000..3def5e91 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/get-what-to-test.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-what-to-test +title: "Get what to test information" +description: "Gets what to test information for an installable artifact." +sidebar_label: "Get what to test information" +hide_title: true +hide_table_of_contents: true +api: eJylVu1uGkcUfZXRSpVby4AhiSqhOBGSqYtqEwtjR6ljWcPuhZ2y7GxmZrEJ4m8foI/YJ8m5s4sBA5bc+sd62Jl777kf58zOg4hsaFTmlE6DZnBGzoqHWDrhtHBknVDpUJuJ5H2BlZApXlknk0QOEhLSODWUoasGR4HOyPiDnahw9RmO+roPN9i1FOZGuVnQvJ0HTo8J8W7vFndHgZMji3XQWfPbKv3aAAcyaeSEHBnrjVP8QAAVwati1Jl0MdabqfRjEnmuopu3QkWUwp0i41Nw2NmXg6FvuTKEBJzJCajDmCYyaALyLOOo1hmVjoIFAzdkM51asrzfOD7mf5sgPq+XMtJkRaqdoEflSxLq1AEZm8ksS1Toq1f7y7LtPKBHOcmSJ++iItbd8dupTHLiBbfs3un7YiPgkvs0U3oQQ5IuNwTIRzvcPEe132uaJ8nC/x0Fb4/r28lepzJ3sTbqO0Wvyw7uAGvDfh1HqCMufbvXu7/utq77v3/qdf5snyLGhKyVI3oefAXzzTbMSzITZS0PNOZCvR7rG2DddrIH8GW7d9G5uup86t6ftrudZ6i33Syhv9s1Th2gNKlMxBWZKaa5bYw2r4P/zk/Abkd7Uuh0++1et3W+gfxKg5ExqCAeEFk8GO1ZUaLnPc0qMCIedE/QZlBbY11lyTpbm6toUeNZqzhdcUu1YFwF33OTwHg+kJaue+eLmqGEsK5MZAosE4SvTRs1JG5r0zpsp9IoDuHzLa2KWg5lnjA/Yucy26zBRlUHCoy2VFV6p4QUQAS7EfAjHpSLPbW8MlCVc75bqduVf+sjlxr3pBwI9gfNlpoVk4zIbIW8bPVB2pDLbGbM0RxxW5cdEaJuFsdL8VsOu2+0pzYLtY+mXMInekWVxMVTldgPlwd1LYJNG9X6FoLDw3Otx9zYpVbqJGLTj4eH4ovOgQQ3gUojoZyIyVBTvJciNjQ8OdjVGqRdiXRo0fyIHquxmyQf0VFbzYyaIMkuEjopwf7UOF7BxQ9ExfOmjscpXBwIJw0m6uTgfpDIdHzw4abui2MzCt/X5Iev6de0v0KMZiWJGBC4lRkCKSgSYNpvNDA5l7cO+WscN36tokhjdBQqiYShjTOkGcspiYkaGW/GalnqKTseEIrDhymtctAXK1A4QXUrI9xH5EuwIxUF3xwDOf379z/ipiEulobijA05wwCdzrR1cM/NLqfhxWv7eYfnK7n4f/d9OdeOHl0tSyTGGuA8Wecl42+DnYyHbdPf3hukB4tizRfNbTAvyG5w3/DrbzkZ/m64W3HbC0OkLK+hM0OZWHohz5975b3+i/hv3wU7c10SO5151fHKGWA5Bs3998niDqdKpjPgYqMVhpS5NZMtzWZFeZLQs3YfZ5nwm2Iy9mJSLvxH1S44m0KxxMbPxdEek/m8kCoUf3m+2Npr8SRmZeacAXTxB8ZukM0= +sidebar_class_name: "get api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gets what to test information for an installable artifact. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/list-apps.ParamsDetails.json b/docs/release-management-api/apps/api-reference/list-apps.ParamsDetails.json new file mode 100644 index 00000000..b74c7529 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/list-apps.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspace_slug","in":"query","required":true,"schema":{"type":"string"}},{"name":"project_id","in":"query","required":false,"description":"Specifies which Bitrise Project you want to get associated apps for","schema":{"type":"string"}},{"name":"platform","in":"query","schema":{"enum":["ios","android"],"type":"string"},"required":false,"description":"Filter for a specific mobile platform between your apps"},{"name":"search","in":"query","required":false,"description":"Search by bundle ID (for iOS), package name (for Android), or app title. (case sensitive)","schema":{"type":"string"}},{"name":"items_per_page","in":"query","required":false,"schema":{"default":10,"maximum":50,"minimum":1,"type":"integer"},"description":"Specifies the maximum number of apps returned per request"},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer"},"description":"Specifies which page should be returned from the whole result set in a paginated scenario"}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/list-apps.RequestSchema.json b/docs/release-management-api/apps/api-reference/list-apps.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/apps/api-reference/list-apps.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/list-apps.StatusCodes.json b/docs/release-management-api/apps/api-reference/list-apps.StatusCodes.json new file mode 100644 index 00000000..f76c72c8 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/list-apps.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"List Apps","content":{"application/json":{"examples":{"200 - List Apps":{"value":{"items":[{"id":"aca7efd3-edf7-4a3f-bfd5-3a4bb58a0335","created_at":"2025-02-11T09:26:01.000Z","platform":"android","project_id":"23c9f973-6b65-4aca-945b-a6eb4a0a9913","workspace_slug":"workspace-slug","icon_id":null,"icon_url":null,"app_name":"Test Android App","current_user_release_management_admin":true,"framework":null,"latest_version":"2.0.5","latest_version_date":"2025-01-29T09:26:01.000Z","latest_build_version":null,"latest_build_version_code":null,"license":"basic","project_title":"Awesome project","store_app_id":"io.bitrise.test","store_connected":true,"store_credential_id":null},{"id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","created_at":"2025-02-11T09:26:01.000Z","platform":"android","project_id":"23c9f973-6b65-4aca-945b-a6eb4a0a9913","workspace_slug":"workspace-slug","icon_id":"dd6fadd2-6e4b-4bda-b6e2-aa319cdc89cd","icon_url":"https://storage.googleapis.com/rm-public-assets-storage/apps/f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de/app_icon/dd6fadd2-6e4b-4bda-b6e2-aa319cdc89cd/icon.png","app_name":"Test Android App","current_user_release_management_admin":true,"framework":null,"latest_version":"1.1.3","latest_version_date":"2025-02-10T09:26:01.000Z","latest_build_version":null,"latest_build_version_code":null,"license":"basic","project_title":"Awesome project","store_app_id":"io.bitrise.test","store_connected":true,"store_credential_id":null}],"pagination":{"current_page":1,"items_per_page":10,"total_count":2},"counts":{"total":2,"with_basic_license":2,"with_standard_license":0}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Not found","content":{"application/json":{"examples":{"404 - Not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/list-apps.api.mdx b/docs/release-management-api/apps/api-reference/list-apps.api.mdx new file mode 100644 index 00000000..69979565 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/list-apps.api.mdx @@ -0,0 +1,69 @@ +--- +id: list-apps +title: "Get a list of apps" +description: "Gives back a paginated list of apps your user has access to for the workspace specified based on given filters." +sidebar_label: "Get a list of apps" +hide_title: true +hide_table_of_contents: true +api: eJzdWNtu3DgS/RVCwCIXWH23PW1MZuBFnKyxiW34EmAnEzQoqdTiWBI1JGXHa/h1P2A/cb9kT1Hqm9t2bG/2gu0HoUWRVadOsYpVvA4SsrFRlVO6DHaC9+qCrIhkfC6kqORUldJRInJlndCpkFVlxZWujagtGZFJK2Qck7XCaZFqI1xG4lKbc1vJmIStKFapgoBIWjx1KaZQUIpU5Y6M7QQbga7ISNa+n0D/ByjahRJ8sBTXRrmrYOfzdeD0OQHf5y83XzYCJ6cW/wM/Ee+VNLIgFujnlniBqDmMic3rKQQqNvD3mswVXgz9XitD0OlMTdAWZ1TIYAeqripebp1R5TS4udmYS6yM/o1iN1HJ/dJSmVuIW2X1pOXBistMxZn4o4JwS+KoEciMiktZOmZxSk5Ia3WsPPOecTAbPBJiLh1mF7cBLtZSWRdMntJMsiwTo2EPs7oq9JtGvfM+9F6XM0/HotCRyknMcIiI3CXB437TsDHBElpL0sTZU8n0i0R0JaK6TKBr/614ySjU4cmrDWza+FxOSbCKZny3sRHftIcgnHI5dcTLGJtSWCqtctiVrx5JsXJU2Al27QTxQd8EvxCZUCrr3AU7/d5GUMivqmBPbPKLKpuX/twNqnQ0JcN+uG8vcay1YgScGsEZsxA15GpTYvsApmBIZN0y8c9G/lyszb5ntcJmus6REWiBMjW6aFJHpnMet9AGzzihypU8ZGMqpVE64DSAaZUuLVmGOOj1GqTL+jmbiDadxBooS8eTQFGuYp90ur9Znomw+CqLKp/LEqFYLMbQhcxr4j/e+z7NKM5XMpbblCbDkJJ0OxzJYRpGabIZDuUoijZ/kL3hcJOVG2L8Ewn9ED/YDHuDsN8/7Y13Bls7vX6n1+v9gnnz8N2ZR+bGctrB4mE8Tsfbw3Ar2tqEwliG49FmFMotikayJ8fj/hBrbiW/pWwYzrIhCPEiyzrP29fa5LN3cDRpN8spMRENHCaE7amNAZkTPgUmhnJCJE0KWcK/BY/LpOC91aTWlLMz65/JhpEQOblAwm78NOj0OkzT6odJgtc5X/1wMF7jq10Q1SpPFvJWtKx8m8Q6ofkEhd1kWQNOJxUvMe0TBMZ3L8lqpJF2nBOE04YmTI73htKdqMnlHVY2nwAySyxYOl6aYYQX6FEynzPPQelFpcMkTnvjUTgaUy8cpdE4jLaiURjHg8H2OB1Ew4T+x3dSkCRbqUySQbhFoygcRYmEDTQIpRz2x3ES/4BHsLzXgsy5yu50u8wPNk9nqvUUu6lSthPromuKsKojOCrEkUjOhu28Lme57mMo63pfQWH3MeC6PLNTlWzWfzQC+p1+Z/iNCICfe/+PEeArOJ/hVZOLZ9z6U4rPmVtHrj9AnXYQEuuac/rghhM8/vpk7T9hEJtXuWzibZvMbZ0NW4fAkCZZfOndNL+NYNTrr58mZ6WsXaaN+islTztQIA4Hysr65TOlcUmwd3w8OTvYPTv90+Hx/i97b6GjQGntLV5VvoA5XId5RKZQln0tQLV6OtYhsK4LuQfw0d7xx/2Tk/3Dg8nbvYP9W6jXxSygj9ahH2iHehJV3VMhjwB5sfgeqAeHp5N3h2cHqxBPM19woDxFwxLLsoQY1CaNpBnazbuqi30ANKXMxQkZRJfYM8bX6U9AvukrjbsF3WPF/sHp3vHB7ocVI04Qoy5DpSouoVlcGu2L1hY9f9McrOgtOMaly/DS9T0WK2zqmSYhX3Ondnb84abbJrVwkdS6F4Mm8V70sfYChZiMWkPaVSvF4jy5I53PkwRqt9tVInugAeLbRAE5giPUV4S+CKUOG/Nl0ROe+NE22H1nOK/YoezPdDUrbjOSCZk1lUe7pwLpifkzV9x1IY2L3aN9bIA852qxTfyzmGtSE3OpylR7bW2CPG5YEh/nLLEcpmee2y8Gnf4agtevP2h9zh6btc0aRTGW/vz6tfgL+kFsRbTJZSKUExkZ2hE/SpEZSt+8uMs1MDtMdGy7WEJfO5kr8p/hUdupjCpg5AEMetOC/cOgt4CLF2jF81Mfj7cQ8UI4abBV3ryYRLksz1/89KnvyeEm78eu/OnX8tfydIEYzspzjpmEKkOxL9QR8O8oMjXT28fhiRNsuwOSzuHR2hAMlk3bm8kLdDFqavwyeIKpKOnSC44I5PBkKjus9EEGGiFgN5zWKiFPwR2mKMhmHbDpH3/7u/g0EB9nC8V7XsgWcitTaesgnp3d7ob3qEDQjixfhtz26/Ui+v8LdyltCDj66rooABEBsMPH9XUb9Z8DbvUzmMb/r5toN/nNDQ83nSDngkRZDu17WvBlI18et23jK3EfgHOE4x3XMW1yC3xf+niF3+cu5QGgK7c8zwT53LuRh4Et7naey92/8erkAeDza55/2eVPvfJ4ENbaRc532pHf75bj4e1wG/SXxZnsb0o3ZqcfR3SzZhcJpnJLq9YKFJYyrxfe751yI1Rz5lg+YM/9Adv+8dez7afyaln2yuE5g81P5vfOJdfXzfGNfDSb33y6d8X8gG99yhagVvgnsE/NQQ== +sidebar_class_name: "get api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gives back a paginated list of apps your user has access to for the workspace specified based on given filters. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/list-custom-access-links.ParamsDetails.json b/docs/release-management-api/apps/api-reference/list-custom-access-links.ParamsDetails.json new file mode 100644 index 00000000..ed70b399 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/list-custom-access-links.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"installable_artifact_id","in":"path","required":true,"description":"The uuidV4 identifier of the installable artifact.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer"},"description":"Specifies which page should be returned from the whole result set."},{"name":"items_per_page","in":"query","required":false,"schema":{"default":10,"maximum":50,"minimum":1,"type":"integer"},"description":"Specifies the maximum number of items returned per request."},{"name":"sort_by","in":"query","required":false,"schema":{"enum":["name","created_at","expires_at"],"type":"string"},"description":"The field to sort results by. Defaults to name."},{"name":"sort_order","in":"query","required":false,"schema":{"enum":["asc","desc"],"type":"string"},"description":"The sort direction. Defaults to asc."}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/list-custom-access-links.RequestSchema.json b/docs/release-management-api/apps/api-reference/list-custom-access-links.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/apps/api-reference/list-custom-access-links.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/list-custom-access-links.StatusCodes.json b/docs/release-management-api/apps/api-reference/list-custom-access-links.StatusCodes.json new file mode 100644 index 00000000..1d13ee8d --- /dev/null +++ b/docs/release-management-api/apps/api-reference/list-custom-access-links.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Custom access links","content":{"application/json":{"examples":{"200 - Custom access links":{"value":{"items":[{"id":"aaaaaaaa-0001-0000-0000-000000000000","name":"Alpha link","created_at":"2025-02-11T09:26:01.000Z","expires_at":null,"url":"http://unittest.bitrise.io/app-install/-6vgdwOcrQEagiCKvA6HKjnKOmSrl8ojUe1_DEODbP8","creator_email":"default-user@example.com","creator_name":"default-user","creator_avatar":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png","tester_group_name":"Beta Testers"},{"id":"aaaaaaaa-0002-0000-0000-000000000000","name":"Beta link","created_at":"2025-02-11T09:26:01.000Z","expires_at":null,"url":"http://unittest.bitrise.io/app-install/3bkkZjTdmuuMsUoJeX9brMihAAkK86c4vij_2uAf6xM","creator_email":"default-user@example.com","creator_name":"default-user","creator_avatar":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"}],"pagination":{"total_count":2,"current_page":1,"items_per_page":10}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to list custom access links. Only Admins, Owners and Workspace Admins can list custom access links."}}}}}},"404":{"description":"Installable artifact not found","content":{"application/json":{"examples":{"404 - Installable artifact not found":{"value":{"code":"ERR_NOT_FOUND","message":"The installable artifact cannot be found."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/list-custom-access-links.api.mdx b/docs/release-management-api/apps/api-reference/list-custom-access-links.api.mdx new file mode 100644 index 00000000..c7190e8a --- /dev/null +++ b/docs/release-management-api/apps/api-reference/list-custom-access-links.api.mdx @@ -0,0 +1,69 @@ +--- +id: list-custom-access-links +title: "List custom access links for an installable artifact" +description: "Returns a paginated list of custom access links for the given installable artifact." +sidebar_label: "List custom access links for an installable artifact" +hide_title: true +hide_table_of_contents: true +api: eJzVWOly2zYQfhUMZzppM6Ku2G6iyVE1dhLVh1JbTtukHg1ErkRYJMAAoGRHo799gD5in6S7IHVZUlK5x0z1Q0OKxLfffgvsoYkXggm0SK1Q0mt452AzLQ3jLOUDIbmFkMXCWKb6LMiMVQnjQQDG4K9yaFhfaWYjYAMxAsmENJbHMe/FwLi2os8DW/ZKnkpBc7LQCtHGCeK9dFhNB3VCSPiWgSDTwt56jQ8Tz6ohIKEPV9Orkmf5wOC111rCbxb4xsMXUq55Aha0cYsl3qChJTrdGZ2uCNGUIF9TbiO81vAxExqQmdUZlO4I0kHnskyE7/aYCEEiiABNapDX2/w1QQQJ9xroxm1KTIzVQg686bQ0J4f6wozJxwz07QqVPo8NLAOF0OdZbL1GreQlQookS9x1YUBICwPQ3vQu/4sUAuJs2DgSQURhBWYilcUh6wHTLt4Y5L7G0JJP40jF9LtBa8wA+rNEWlhITBej2b03/Sry5zc5//3qfZ0hpgUMk1nSy2Pi6C18Qp6MOIFZ9cIobbu92x3ogySGH3KAkhdooJPR5RZv4CbFVYZurkp3A75pO6EDKL5VjHgUShvWuy2zw1wlQw/J1DprpUMUZnfi3ARezuUvknTcQkQN6MdVagiGzK7IsEmVNGDIVL1azSO9DPVyPWeQfgojLC29ztM0FoFLDpVrQ2uQ9A1P0niOyny2CQYfjnicAV24wLujLyjD8OLjV6vVGn1VF1+zD9IohG3GacQd6GpoG2i8vu9X636t1qk+adQPGtVaGZe+X416Q2ZxXPIyHeOSyNq0UalkUlhL+64nUGQDZaEq6KpfZIyKfzAahON2oH88wjz78njUPHhzfC2P28mFjh+r60uodQ+P2oe9t49npJTuYlAFGSlOk58Z0N8VapUDlSy9Wvi2/ObSUz7iluuCrkG+BU0/zXoYDr8IkJ9qFWb5DjCPyjzhn5TkY0O2KgTpC3zTVHI4vzBWTnFT4SZD9zFRDLTK0hmd78Fy1nEPjNvba+GqfzFcDuO/jdaj3nD4/roTJll2ai7VD/Dzk54+FVGzOTx+fBDsjcR1t541+wc3p//PaE1dDXUFX+Rn0Cr0vBuojI5pHblkWqONPO9Trr5TCjCxT/NPydur1tYzwaXkmY2UFp8g3C0FIBymgJX1y2c/UCFpd3R+3r08a1523rTPW++PDtFGgsnCcVs1vqD5aJ3mW9CJMAZvGJZ7sTvXR8h1HWQL4bdH56eti4tW+wxP+1nrDutfVMYiPgImFdWyAtKlYNeTbWjIyqwt41vWDLGsmhJrjyWeNMZlyH5SemhSHkDxkAVcbodZEmlvXaTWhr4HSVpsBzO5s2J7qNgXELfId9budF+1L89WZets6czIY4LEtsehLpzc31S6WuiCljxmF6BH2Ekcaa30br7tu+K1GWiLS62zztH5WfNkxaMLhc1thLWajdEyG2vlmsmCPT1TlEcHQP2Ia2sbXmVJAn8mgalMtjTF00q+Dfx8G/jxvCknznltzXPmpMcNXJ6fTCsaYsBrP+ESeSZIrTKqU+I0lVEN1464FmTHaVGsWmkG5wmNp2Ip93obG5JcPIJhiMPGwkauDXTNDrhgXi2GiAv3q8lTmRsl5s04GjuGefcXAc9bqjt5oNlhEkgKrm/pxGECZc23LdxEcWwW1WiWV/LESeEQsq+cNWFjcCOVU4mdzlUiHJIHdc2Njerl2hqDhw9PlBpS0GdDlsK2EZe+ePiQUWqgA9wXeLSFZRFoaLCnnEUa+s8ebAoNuu2HKjC4MUK4KUc2iV9gRE051SJBJ8/QoWcF2a/q1QVdvEGr+P2uhl+HCPGAYQHB3fbsQbcXczl88PxdzYljsEF/WuHPf5W/ys6CMQYrjunchZBiR+mmSsyNr6CnM5K3hlkIq/e3ZRRpiBHNNKDD3LLbWQZMxEC7ZRgJkkLC2AH3AMWhl0GWyehnFchBUF1/gBMdOAk2uCIQm2ygT3/89jt7V2ens4XsNS0kD6lrTpWxCE/BLnYDjbZm66DMN0/IdyM/WaSYf2keLw6ChRtbSWOO52BadESTIn188DamD1zb2D5Vb8ogeCQjlIkQJ3nm0PF0Sj/n0wvllVAYQlvML1vl+Aem2S3eDzEjzIfyIjF7rkW9D7vdx9PP0lobu+9JcNfp87OkFlP032DzxTHzyxRmI/GCxdWi9Oy4v74+L0bpb9i9/vjZyHVWduSKVvPYbjlO0ytcWhQnciJ/m/4xS+0SzloLQt7PO4LXRx18l2rUav0buvpXXLi/2zZxXK1tM8L0TYHeuGQyyasrHvHZ+/mjrSvm9XcmB3k+nf4Jzr0b+w== +sidebar_class_name: "get api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Returns a paginated list of custom access links for the given installable artifact. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/list-installable-artifacts.ParamsDetails.json b/docs/release-management-api/apps/api-reference/list-installable-artifacts.ParamsDetails.json new file mode 100644 index 00000000..1621221f --- /dev/null +++ b/docs/release-management-api/apps/api-reference/list-installable-artifacts.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"app_id","in":"query","required":true,"description":"The uuidV4 identifier of the app the artifact is connected to.","schema":{"type":"string"}},{"name":"artifact_type","in":"query","required":false,"schema":{"enum":["aab","apk","ipa"],"type":"string"},"description":"Filter for a specific artifact type/extension."},{"name":"after_date","in":"query","required":false,"description":"A date in ISO 8601 string format specifying the start of the interval when the installable artifact created/uploaded. This value will be defaulted to 1 month ago if `distribution_ready` filter is not set or set to `false`.","schema":{"type":"string"}},{"name":"before_date","in":"query","required":false,"description":"A date in ISO 8601 string format specifying the end of the interval when the installable artifact created/uploaded. This value will be defaulted to the current time if `distribution_ready` filter is not set or set to `false`.","schema":{"type":"string"}},{"name":"branch","in":"query","required":false,"description":"Filter for the Bitrise CI branch the artifact has been generated on. (if applicable)","schema":{"type":"string"}},{"name":"distribution_ready","in":"query","required":false,"description":"Filter for distribution ready installable artifacts. This means `.apk` and `.ipa` (with distribution type `ad-hoc`, `development`, or `enterprise`) installable artifacts.","schema":{"type":"boolean"}},{"name":"items_per_page","in":"query","required":false,"schema":{"default":10,"maximum":50,"minimum":1,"type":"integer"},"description":"Specifies the maximum number of installable artifacts returned per request."},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer"},"description":"Specifies which page should be returned from the whole result set in a paginated scenario."},{"name":"platform","in":"query","required":false,"schema":{"enum":["ios","android"],"type":"string"},"description":"Filter for a specific mobile platform between your installable artifacts."},{"name":"search","in":"query","required":false,"description":"Search by version, filename, or build number (Bitrise CI). (case sensitive)","schema":{"type":"string"}},{"name":"source","in":"query","required":false,"schema":{"enum":["api","ci"],"type":"string"},"description":"Filter for the source of the installable artifacts."},{"name":"store_signed","in":"query","required":false,"description":"Filter for store ready installable artifacts. This means signed `.aab` and `.ipa` (with distribution type `app-store`) installable artifacts.","schema":{"type":"boolean"}},{"name":"version","in":"query","required":false,"description":"Filter for the version this artifact created for.This field is required if the `distribution_ready` filter is set to `true`.","schema":{"type":"string"}},{"name":"workflow","in":"query","required":false,"description":"Filter for the Bitrise CI workflow this artifact has been generated by. (if applicable)","schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/list-installable-artifacts.RequestSchema.json b/docs/release-management-api/apps/api-reference/list-installable-artifacts.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/apps/api-reference/list-installable-artifacts.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/list-installable-artifacts.StatusCodes.json b/docs/release-management-api/apps/api-reference/list-installable-artifacts.StatusCodes.json new file mode 100644 index 00000000..6dddce9d --- /dev/null +++ b/docs/release-management-api/apps/api-reference/list-installable-artifacts.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Installable artifacts","content":{"application/json":{"examples":{"200 - Installable artifacts":{"value":{"count":3,"filters":{"after_date":1736673961,"before_date":1739265961},"has_next_page":false,"items":[{"app_name":"My Awesome App 0","branch":"master","build_number":"116","build_slug":"installable-artifact-build-slugi0","created_at":"2025-02-11T09:26:01.000Z","download_url":"some-download-url","filename_ext":".ipa","filename":"MyInstallableArtifact-1","id":"installable-artifact-slug-0","public_install_page_url":"https://app.bitrise.io/installable-artifacts/c71c1a5a-afe5-4129-a1a0-c3e1df2e3765/public-install-page/7eed2f6a199efe6b","platform":"ios","signature":"app-store","source":"ci","storage_provider":"gcs","store_app_id":"com.no.store.app.id","type":"ipa","uid":"c71c1a5a-afe5-4129-a1a0-c3e1df2e3765","formatted_version":"3.2.0 (1739265916)","version":"3.2.0","version_code":"1739265916","workflow":"build-ipa"},{"app_name":"My Awesome App 1","branch":"master","build_number":"117","build_slug":"installable-artifact-build-slugi1","created_at":"2025-02-11T09:26:01.000Z","download_url":"some-download-url","filename_ext":".ipa","filename":"MyInstallableArtifact-2","id":"installable-artifact-slug-1","public_install_page_url":"https://app.bitrise.io/installable-artifacts/75813a9f-33ce-4789-867c-3935f0aefe96/public-install-page/02bbfc0fed892eda","platform":"ios","signature":"app-store","source":"ci","storage_provider":"gcs","store_app_id":"com.no.store.app.id","type":"ipa","uid":"75813a9f-33ce-4789-867c-3935f0aefe96","formatted_version":"3.2.1 (1739265917)","version":"3.2.1","version_code":"1739265917","workflow":"build-ipa"},{"app_name":"My Awesome App 2","branch":"master","build_number":"118","build_slug":"installable-artifact-build-slugi2","created_at":"2025-02-11T09:26:01.000Z","download_url":"some-download-url","filename_ext":".ipa","filename":"MyInstallableArtifact-3","id":"installable-artifact-slug-2","public_install_page_url":"https://app.bitrise.io/installable-artifacts/92128991-72e5-4f31-b88c-a196b0ae963e/public-install-page/773971a2ecac09c3","platform":"ios","signature":"app-store","source":"ci","storage_provider":"gcs","store_app_id":"com.no.store.app.id","type":"ipa","uid":"92128991-72e5-4f31-b88c-a196b0ae963e","formatted_version":"3.2.2 (1739265918)","version":"3.2.2","version_code":"1739265918","workflow":"build-ipa"}]}}}}}},"400":{"description":"Bad Request - app_id is missing","content":{"application/json":{"examples":{"400 - Bad Request - app_id is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: app_id"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/list-installable-artifacts.api.mdx b/docs/release-management-api/apps/api-reference/list-installable-artifacts.api.mdx new file mode 100644 index 00000000..124ecc76 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/list-installable-artifacts.api.mdx @@ -0,0 +1,69 @@ +--- +id: list-installable-artifacts +title: "Get the list of the installable artifacts" +description: "Gives back a list of installable artifacts." +sidebar_label: "Get the list of the installable artifacts" +hide_title: true +hide_table_of_contents: true +api: eJzdWutu4kgWfpUS0qovwoBNwk3TM2K2M71ou9OtJN3STk8EZfsAtbFdnio7NBPl7zzAPuI+yZ5TNmDCJUDYVnbzg+By1anvXOpc6nBX8kF7SsSJkFGpU3onbkEzl3s3jLNA6ITJIRORTngQcDcAxlUihtxLdKVULskYFKeVPR/XvsfpvcXU7mwmTtTgpUok01Ln610pkTeAe329vr8ulxI+0vi9VFjIFitxQswVDyEBpc3iCB9wLx7HfeEjZUGof09BTfFBwe+pUIBgEpVC+QFvV2NgaSr8LydM+BDhHgIU8ZfgCySY/c/3ZkIzT0YReAn4LJHErvbGEPJSB1mYxoRCJ0pEo9L9fXkBLF/fN1M24hvyQEORIkRpSHLg3MWJPL6htTEnCTzY7CFbv4gApcOGUqHKdAwe8uUt+KDVVfiWQKRxfqVUxDrEhX2fJ48DXd6yy2gR2gXrXX5krUbNZhk6QhHyJIcxpRESKqpWJTNJiwh3veUBm4whykdW7Yt5CnAPv5rGgeQ++BV2NUad4MIU2EQEAXOB+TDkaZBpiNkslFEyZnwkmRiygS8IlJsS6D5S86cDNsyEhYQiiTABUSnzD9cPDK+DXTXtAjIL30N8EPn/deERKTyjCs8FS0QI30WCikfeeE/hFcydMP8skK4G9tcey8gtn+IxR28GKKoRROSrkFk8BOwlcocnPhAeye3VjnhXxXE49iItZmhtcLOZ5kLgkWaDCjqGAeNoD4MKeocBezkRaPFLxAg/G3DfGktvUEYlwi0EMg5Rs/iIWw+AjCgmsQ1ebXbuKxJxpQwQxpJIRAKh7mMY6Md8tI+/y42v1LFr5VLIv4mQ/N8pPYgoe7Dnro+sfgRq1fddZu4OQxZpPSfD0JW6mWdfyxyKO0lVhKaAuBlhBJ0sOcaDeTkU/WQs0HJpW6bHMg18Op9zmEMlQ8PgZIwawHGNu5kzhy6E0zIRGdPWHkRcCbnMTMAT8isHBCMhKXijuSmJwfbQUBRKVyDsGQ5kLZnQkZzKVG0yvwJ+DVzt7SUuzSLmTtktZg44VibHBUTSnAE3FSjk3FBeLpzIK/QNHsevmuJlgtnQrs5BIzfeQRE/FjjRE/vJ14RVs+UiNDwqyYQClhYjNKrDPZehsrPLynYjz8XdHT1XHFtmjyc7p1z1TwswORH8jjw9DLA0q2K4xWOMBiU0m1GnAErrHwmis8hJCevOgXMi1c0wkJOjhc4ZwQdcrome7nS/6HlNqHQsIw2a3ju1WuYyi8B669RMhwLzOQxWtCDfjxZU/6lpFZ6gbzyMgzldZrH1hPC1yXzoiydTIlgvlzIdmLeFRLhjN+uNRrPebqADL6Z49KLtNE7xBZ5LlEw/wqw6C3szcZtoaMoUqk9yZX2Ysu4EtMScqotFRg35yhOfDgY+jTvTCPmjfuaPcNy2G/NBHaQjE0XmrFkz1iwzw6IZgujmVtnnyCFKxDm1ao5l21e1dsdpdGp2pVar/YrzfDmJKDHspyowrisEazZm0ZiRjvGWfWQSp9CZLYwattbUepZNJulvgktALQIapy5qs59PMkLMsYyTJNadahUFWHEzA60IWV1HTle9pu3Z/JRbfAin1onttC1u85rl1cH2hw7Um43TaraXlVOwaK9qE8B3hg1ut9swhAaVXPMw2cnDHnkujhE4Lzczn0TjmaPvkMsuG59K6GMlb7GqJOWNPJ2/gH5ep+JkGVYiWTGjFWLOVK+zDMEIN80m7sATacJUCqTsmZfrlOoVp1JjL2eGajfoaD54vRjpe9KnzRfT8d3cs3Qy67MIGnmezQZt72bQzX0N2n4WBu08btD28Qy6edqy67w9tOp1D6yTZqtttRpNz6q366fDGkdbbTfWGnTNcd2hVxuC32o74PNnZNC78LTFoO2CQTdXDdreYtDNwwza2c2gW/satPMsDLr+uEE7xzPotmM7rXbbtpoOebNh3bbcVstDl9ZuuKj8dqMO6z00KrFpcwc87tXaXv0ZGfQuPG0xaKdg0K1Vg3a2GHRro0Ff35u/culkXX71M/fZRVbnYpKUcUzJZyi0pjRtr0zrxGRaj5FczrkMG2cXF/1P3Yvuh7Ors4v+h97lZe/8He4dgtYmi8ruegtU2CwHN/dWOA5hnExpVEQ4JvxOvnNpwb69yv7niKfJWCrxh6l79uLVRu6W1m9g7PN59/PV3z5e9H49e7vE09LiBcz6KsxPoAzfWGz4EIn9sdYR6yqRTZo4uzAq+Hjef3t23nuAepXMDPrp+gQenWTEA3YJCo2XnSkl1X7wT/MEfh2hDSz0ztGQzrvvl5BfoqvEKgaNZ0J3mRMlTR2So6d3kg7xCBJyKTwhJ7/eeZm+BaHIUvrM+925XMPni/f3VQVYcGqwQh7hznS9Vr11yCvq6q2JSlwJImi4y1ct3RYVPKkoeNLSur5FBoQRGYZ0mCmezR0AVV5QIQ6vF32WSzNqds67LfPKDDf7O8wvLsdYj5rw9sAUu1csAo+EqqZUn6a4b/dTj3koJRLMrIOQm7ZRK5WoSHUozW4iCWjGRSYl9mEuJaKz5PVusyi+jOD16/dS3uR34oZTifU1Lv3p9Wv2D5kikgjL6AidDtapoKDDfuBsrGD45sU61SDbGEA9jar24VtlnITBT6hRXYmVCJHJc2ToTQ72L05tARcfcFf8/GLjx1sk8YIlXKH9vHnRdwMe3bz48YtthEM3Xj9U+Y+/Rb9FVwvEhQv3WGE8yy6h2S/gqpTEa6MLxVSgWUEh3aBGMaAhwzyhCzIswW8B3eEoq77zi/oIJoZwVp/SUFShTbdKICOC0rVGGMfAiGANKwImZg/k6d9//ot9cdiH2UL2jhYSh3Q1FUudIHlSdm4N7yDJLmJnjcMt11IP9H23cBV79iBzs04wC6pihoBWjdjMWb3Lj/fXtamOaS6OkQeacJcdaxXc39Nwdp9Ch94XmlZtuFEpon55kV++vGJPbjSu5ekGT22h8Zk7xJJJZneHuWe3cDuWB73OAyH933cTt4mw2IL9TvL7X2wnbhHhch/26cfimF3FbbBnzc+nI37+vcQtcljbVD1QJsdsB24FvdL2fDLgo3cAt+J/Gurjtfm2g1w0Lg8V71G7gFugznuUx3E/OzX2tgOadSOfDuhZ9Pu2sbrc1TyOBr53128Lf4su5tFj21PbfltQF1qUC9jXi6rY/P6vPKs/KdXO1nU9D+KksGrl3oCozMv4d2dX9AuFlPL8Yol7Y0rc/Iv50WH+KiqGl+XydQadPknCa5fc3WUFNBYKcwWZVxtXzEvsPHRE2W3dfwCATT0R +sidebar_class_name: "get api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gives back a list of installable artifacts. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/list-outgoing-webhook-deliveries.ParamsDetails.json b/docs/release-management-api/apps/api-reference/list-outgoing-webhook-deliveries.ParamsDetails.json new file mode 100644 index 00000000..2c599cf1 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/list-outgoing-webhook-deliveries.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"Release Management webhook UUIDv4.","required":true,"schema":{"type":"string"}},{"name":"after_date","in":"query","required":false,"description":"A date in ISO 8601 string format specifying the start of the interval when the delivery occurred. This value will be defaulted to 30 days ago if not given.","schema":{"type":"string"}},{"name":"before_date","in":"query","required":false,"description":"A date in ISO 8601 string format specifying the end of the interval when the delivery occurred. This value will be defaulted to the current time if not given.","schema":{"type":"string"}},{"name":"items_per_page","in":"query","required":false,"schema":{"default":10,"maximum":50,"minimum":1,"type":"integer"},"description":"Specifies the maximum number of installable artifacts returned per request."},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer"},"description":"Specifies which page should be returned from the whole result set in a paginated scenario."},{"name":"status","in":"query","required":false,"schema":{"enum":["failed","successful"],"type":"string"},"description":"Filter for a specific status."},{"name":"source_event_type","in":"query","required":false,"schema":{"enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed","app_store_release_cancelled","app_store_release_completed","app_store_release_started","app_store_review_approved","app_store_review_cancelled","app_store_review_rejected","app_store_review_submitted","app_store_version_created","app_store_version_updated","app_version_added","approval_task_added","approval_task_changed","approval_task_completed","approval_task_deleted","approval_task_reopened","approval_tasks_completed","auto-upload_disabled","auto-upload_enabled","automation_added","automation_removed","google_play_automated_rollout_cancelled","google_play_automated_rollout_configured","google_play_automated_rollout_paused","google_play_automated_rollout_resumed","google_play_release_completed","google_play_release_notes_localization_added","google_play_release_notes_localization_changed","google_play_release_notes_localization_removed","google_play_release_started","google_play_rollout_percentage_changed","google_play_testing_track_release_completed","google_play_testing_track_release_failed","google_play_upload_completed","google_play_upload_failed","google_play_upload_started","metadata_localization_added","metadata_localization_changed","metadata_localization_removed","microsoft_teams_connection_changed","outgoing_webhook_added","outgoing_webhook_deleted","outgoing_webhook_updated","phased_release_disabled","phased_release_enabled","phased_release_paused","phased_release_resumed","release_candidate_auto_select_latest_build_disabled","release_candidate_auto_select_latest_build_enabled","release_candidate_build_selected","release_candidate_source_changed","release_description_changed","release_settings_changed","slack_connection_changed","stopped_managing_release","testflight_app_review_approved","testflight_app_review_rejected","testflight_app_review_submitted","testflight_distribution_start_failed","testflight_distribution_started","testflight_distribution_stopped","testflight_processing_completed","testflight_processing_failed","testflight_upload_completed","testflight_upload_failed","testflight_upload_started","testflight_what_to_test_added","testflight_what_to_test_changed","testflight_what_to_test_deleted"],"type":"string"},"description":"Filter for a specific event type."}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/list-outgoing-webhook-deliveries.RequestSchema.json b/docs/release-management-api/apps/api-reference/list-outgoing-webhook-deliveries.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/apps/api-reference/list-outgoing-webhook-deliveries.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/list-outgoing-webhook-deliveries.StatusCodes.json b/docs/release-management-api/apps/api-reference/list-outgoing-webhook-deliveries.StatusCodes.json new file mode 100644 index 00000000..a766641d --- /dev/null +++ b/docs/release-management-api/apps/api-reference/list-outgoing-webhook-deliveries.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Outgoing webhook deliveries","content":{"application/json":{"examples":{"200 - Outgoing webhook deliveries":{"value":{"items":[{"created_at":"2025-02-11T09:26:01.000Z","id":"dc1e1231-a407-4391-91b0-e0f4b3ee022b","request_headers":[{"name":"Authorization","value":"Bearer token","hide":false},{"name":"X-Custom-Header","value":"custom","hide":false}],"request_payload":{"release_id":"8ef26387-98aa-43fe-b113-fe32b606b87e"},"request_url":"https://example.com/webhook","response_body":null,"response_headers":null,"response_http_status":null,"response_duration_seconds":0,"source_event_type":"release_candidate_set","source_product":"release_management","webhook_config_id":"5623239f-28ea-4b8d-856e-8cb50073fade"},{"created_at":"2025-02-11T09:26:01.000Z","id":"ed404b37-35ce-4e9e-859c-5d24c6bd603e","request_headers":[{"name":"Authorization","value":"Bearer token","hide":false},{"name":"X-Custom-Header","value":"custom","hide":false}],"request_payload":{"release_id":"8ef26387-98aa-43fe-b113-fe32b606b87e"},"request_url":"https://example.com/webhook","response_body":null,"response_headers":null,"response_http_status":null,"response_duration_seconds":0,"source_event_type":"release_candidate_set","source_product":"release_management","webhook_config_id":"5623239f-28ea-4b8d-856e-8cb50073fade"},{"created_at":"2025-02-11T09:26:01.000Z","id":"c35cb7c7-63ce-4f25-88b8-5dece26b6c6e","request_headers":[{"name":"Authorization","value":"Bearer token","hide":false},{"name":"X-Custom-Header","value":"custom","hide":false}],"request_payload":{"release_id":"8ef26387-98aa-43fe-b113-fe32b606b87e"},"request_url":"https://example.com/webhook","response_body":null,"response_headers":null,"response_http_status":null,"response_duration_seconds":0,"source_event_type":"release_candidate_set","source_product":"release_management","webhook_config_id":"5623239f-28ea-4b8d-856e-8cb50073fade"},{"created_at":"2025-02-11T09:26:01.000Z","id":"41f2bdc3-1af5-4f5f-85a4-d4efe79f9015","request_headers":[{"name":"Authorization","value":"Bearer token","hide":false},{"name":"X-Custom-Header","value":"custom","hide":false}],"request_payload":{"release_id":"8ef26387-98aa-43fe-b113-fe32b606b87e"},"request_url":"https://example.com/webhook","response_body":null,"response_headers":null,"response_http_status":null,"response_duration_seconds":0,"source_event_type":"release_candidate_set","source_product":"release_management","webhook_config_id":"5623239f-28ea-4b8d-856e-8cb50073fade"}],"total_count":4}}}}}},"400":{"description":"Bad request","content":{"application/json":{"examples":{"400 - Bad request":{"value":{"code":"ERR_BAD_REQUEST","message":"Invalid delivery status given as a filter: invalid status. Valid statuses are: failed, successful."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Not found","content":{"application/json":{"examples":{"404 - Not found":{"value":{"code":"ERR_NOT_FOUND","message":"Related webhook configuration not found."}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/list-outgoing-webhook-deliveries.api.mdx b/docs/release-management-api/apps/api-reference/list-outgoing-webhook-deliveries.api.mdx new file mode 100644 index 00000000..5aac3d05 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/list-outgoing-webhook-deliveries.api.mdx @@ -0,0 +1,69 @@ +--- +id: list-outgoing-webhook-deliveries +title: "Get a list of outgoing webhook deliveries" +description: "Gives back the list of outgoing webhook deliveries associated with the given webhook configuration." +sidebar_label: "Get a list of outgoing webhook deliveries" +hide_title: true +hide_table_of_contents: true +api: eJztWv1u3LgRfxVCQJE2sHZX++X14nIH5+zkFk3sdG2n7eUMgZKoFc+SqCMpO67hf/sAfcQ+SWco7UpaaR07lwYFGv9hrMiZ4W8+OBx+3FkBU77kmeYitebWa37NFPGof0V0xEjMlSYiJCLXK8HTFblhXiTEFQlYDJSSAzFVSvicahaQG64jw7eCznRD7Is05KtcUhykZ+1ZImPFxyKAMd/AIKflAH8tWI424oFaMT+XXN9a8w93lhZXDIB+uLy/3LM0XSn4ba25ScmuLOjMqKQJ00wqw5jCBwzGA5DIUdWM6gh+N/VfsphRxchbmtIVS1iqN1pcXCyOrscIX7Lfci4ZYNcyZwDQj1hCrTmgu81wEKUloLHu7/c249IQkLgBmGk9/m85k7cNaSGNFdtGdEiQifCULM5OyWw6cEghnoRCJlQTlTGfh7fYgqZXmkrjM/zgKYx6TWNyE4E/sKV03C0RPlgVhu2R84grAkQ5AwfGMfGQKqR5jC7VgowGAOEWHL0ShIckFbrwL5riMap7DJCyr6E7S4MvqjmyGVoIA80T9lnqc80S5ULEuxmE1CctUIksoVhzZ7BnJfQjT/LEmk/wg6fFh7O3Hhj1XTFp3W/b8MyYCCcqalOKIWmeeEyisXgKERPH1IsZgcjhIfW1IpLpXKZgBcBNECNTumfVtPpsXT4X/U3E/YjgsERFIo8D9NYGZihFYhS8iUSM7QpGI4ppDB6KbDw1KUr5LKWSi4YyYAGdqyeow1LE/8EKKY8ZZhSV+z5TKsxjTD1bwbCt1CsOASYxhgFaEcLcJwWIJi6RS5+5DKJNu0bo0yHKIqO5Pk0DjtPJBasAqwaPhjFfRdrNs1jQwA3BLyoy6qyEWMXMzWJ66yqNs7dN4zFNXcmuObtxaZZJcd1qluxX5mvTvIYBSiM1CIf/pWyEAoZyV1LkWY1WpG4byJpYS1ikgLgYGrR3fZGAXF36w0u4ht9mwAKOkWxwgS18FsclMNNUWN/1I5quGoBNPm20wJSAIIK1h3WQ10FUGtacsBm4o/dB3gpIvW/b/K2+XUNuO6jVtzFhoxMyqIIodn3J6K6+PAtqfetWGgTrNuMwV1N1taO1sutWe9NCtR7I7p3tkkGxkbY7muFCcy3sMsQDrjAZbjdD2qi1JqZ8qdBXTZIlpSvqsVsSQDxKEcdQTjX88gnKsnx6BGlGc/UIMkyPSYuuKwy7+mEFZMqNhU9j/o+mHR5JXrn3kQzdRm3PjEbv2iZd07VO2Mgon7RCN/VmIaiTlpGzS9I6pT7AWmkGlSyFWUW77d7dW6nb3V9ZNeG+FEqEsMowmuDcSFNIDE0h602AW1bEm9FbHdVkbHVVuSGLwHDBxoK1abfVU828rY5NtG+1V+HdXvxwMsAKGIN2bkzRma6X87gx7Z/AVWFrMxUUBdcOknKBby8jtYKha01iGmOwvlypGMOx02+QnLMMzJPgngZ9UYppFgGYqtvLSTdBbdnoJqivHTUKsDGURF5uAJrYrqL/QbJPUBj9mhSgARZkqG59/nVTdIHomLwdJdNuxk7cNxGFKSZMEtlMn139lQd3Uazn2eeWnKawJMgKZeclxpfKRKpg1w0F5HAwKCr3upzT3QcBgBPCT4NEZMMaj/smz/R/VcgLJelHisZcSyc2eUgcEJmtGf4weyizjS/rDpfCKCBkOLEHQ9txzgcH8+F0PnB6g8HgZyyT8WQh8B3mDEeOTceDfXs8OnDsA8cb2GwQjr0RY4Ph0CuraDRnxGiwdVxwmOtIyDJhAmmJyHrJqAR7FqcRe1bEA1bW4LXy/W/2jzkEZ2L/ZATX2H3TvsV4WSHJ6C0GEaq+nvNGoRkLh9PRbN8+mFEKCoXM9hxnZIdsNPSmg6k322fo/LWcXMbAFWmdqXm/X9q/BzHdLw1uVU53PRHcWvM0j+Na48Ym2+0gsyyaW31BedQDeQoiIgAC2LO29zLznXuTkhZmaJD7ukaYbI5lgGq9pBT1UWGgyXQ4Go4OQns4Y2AgbxbYs8mU2TPfmwwG+6MQtDE7rCfFEQvGAwiYfXs08Zk9ZgcgcHLg25NgOPanXjAdjNi3OPoWR5+KIx/ix9v39+3pCOMoBOrZzJtBHDGfDafe1J9+i6NvcfTJOBo74dAL/JHt0HACcTQJQSod28GYhWz/IDwYOJNvcfT/F0dYBwpNY2DNsQwb35u/PWvcVcu9pMH6aPdptdvY1G519nqt5gt0vXW8XLovD4/c5fFfLo7Pzs0mVCk8NZ5bixSoeVAdyRcGL6+NqIIaNTQF65zwkrQ8HSXva194+STZnBRV+B6pDmGhnN1o7rQ1v0hpGf+mvH6S6g6o3uDfofvFyeHF+U+ny8XPx0cN5RvMFcxRG+Y7JhOu8PAMLJXyp2MdAda2kB2A3x0v3y7OzhanJ+7R8cliC3VbTAV93IZ+IjRsNvL0yZDHALli3gH15PTcfXV6cdKEuGRxcQvZde1o7m2M0FpsOMM28jMNk5bKgABQBrOebM7Yn6aJMwRNdgvbodnZ+eHJ0eHyyH2z+PH45OzYTJ/FcssZ5t7KYykLuV6LxEnTGg73e+YSqzgXAOMA7soAk660sMCbs5TG5IxJmJzkWEohn6b8xCSIbkE7FF+cnB8vTw7fNPQ8EwnTUbE/xJtYKczdWoke+wQmx5VJruY+d27110dOdhkHqn/Hg/t+0LxSRkTFilisJXce5OGL5Zv7fpmT7Son96+HfVBZ9a8ds9ZJjoc+RtOSq3HFtVmXaMZ7HocduWI9LqztPfk53tYWpkExBORUN+jmIocZV11WV+BnptWMXF6Eb24eYbA/M7wTMhdE0Xpl3sooh+cEAgENDFlXCwJJlBy+WxCfxjEaZn1b3SgP0Ng8DYUZjeuYdV+Ugxw0T3HcDyTXw57TQvD8+RvwSXmFazQVcYCsPzx/Tv4uckCSQvJPAwKhHTFM799REkkWvnjW5RpQ2w6Er/rAwj72Ip3EP4BHVS+TPAElT0ChFyXYPwwHFVz4gFHh/3sH/h2BiGdEUwmx9OKZ68U0vXr2/XvHGAfPS77r0+9/SX9JzyvEtTvjTDLf5B5INK+YJ3M0r6M0gUpuvwdGugKP5pKBwlSTW1AzoteMJHwlae2uOWU3RnBxY45NaQ8HfdAChRCwrr3KoeoyJuhQhYNsHAN0+vc//0XeD8nbNSN5jYyoIdZYmVAaxKOzy2h4zTRml0c8Bult+/uuShtf6W1JOR00+6j7WUxhNoBOZo7flSnig9VKEcA3Ny9DalkCpl0ksLb5YN0V2UHG9/fYXNy+Yu7YHBp3vl+oK/+//Yyj02hXkE62Hq6s63yzZfnvKf/V33E8oH/z9cpnGuBLPsJ4EG3rscnvBvzF3108iP/3oX74YcWDA2+egHzRoesH7A8P3/HSo0JyWVUdT0w7f1yWBeefyKOetnVCXFcY6W0d1SbkYCtwCVRlyYH4io5D2I1lusbSKhtRsU0V9/r4vLhJj5pVzZWpasof5glgFxy6daBRQMD/6MdOlru7omaCpL6mL7p2cmyqqlJz1AAKtP8AipqW6Q== +sidebar_class_name: "get api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gives back the list of outgoing webhook deliveries associated with the given webhook configuration. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/redeliver-outgoing-webhook.ParamsDetails.json b/docs/release-management-api/apps/api-reference/redeliver-outgoing-webhook.ParamsDetails.json new file mode 100644 index 00000000..627bc522 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/redeliver-outgoing-webhook.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"Release Management webhook UUIDv4.","required":true,"schema":{"type":"string"}},{"name":"delivery_id","in":"path","description":"The UUIDv4 id of the outgoing webhook delivery to redeliver.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/redeliver-outgoing-webhook.RequestSchema.json b/docs/release-management-api/apps/api-reference/redeliver-outgoing-webhook.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/apps/api-reference/redeliver-outgoing-webhook.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/redeliver-outgoing-webhook.StatusCodes.json b/docs/release-management-api/apps/api-reference/redeliver-outgoing-webhook.StatusCodes.json new file mode 100644 index 00000000..d83eed0a --- /dev/null +++ b/docs/release-management-api/apps/api-reference/redeliver-outgoing-webhook.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Redelivers outgoing webhook","content":{"application/json":{"examples":{"204 - Redelivers outgoing webhook":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Not found","content":{"application/json":{"examples":{"404 - Not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/redeliver-outgoing-webhook.api.mdx b/docs/release-management-api/apps/api-reference/redeliver-outgoing-webhook.api.mdx new file mode 100644 index 00000000..9c064cad --- /dev/null +++ b/docs/release-management-api/apps/api-reference/redeliver-outgoing-webhook.api.mdx @@ -0,0 +1,69 @@ +--- +id: redeliver-outgoing-webhook +title: "Redeliver an outgoing webhook" +description: "Redeliver an outgoing webhook" +sidebar_label: "Redeliver an outgoing webhook" +hide_title: true +hide_table_of_contents: true +api: eJylVttuIkcQ/ZXWSJETy+a2jiKh9a5QYBMUGxwujhKvhRqmYDoM07PdPdgE8ZoPyCfmS3K6ZwbMzbtseBjmUnXqVFXX6V56PumRErERMvKqXod8CsWclGY8YjIxEymiCXuiYSDltOBdeDImxa11039p385Mf0stYahplChhFl71YekZOSXgPzyuHi88wyca917uwzIn7eFjzBWfkQED5xjhAXGED0RhGcbcBLjfpR0S18RuecQnNKPI5JRZv9+sz68sc0WfEqEItI1KCARHAc24VwW7RWyDaKPAxlutLtZxs+wWg88Q6AWURWLCZ3LMDF7slo/laMxIpvLKnUbt0RrrWEaatP1eKV3Zv6Nd3OWAYCMZGVTIuvE4DsXItbP4p7a+S4+e+SwO1+jskr0GB6M5DxNwXK7c78K7KpX3KfUjnphAKvEX+adxABw4bPm/CAok3xao0ekM+q1av/dzu9P8o1FHjBlpjdWwG3xD880+zTtSM6E1HtCsSJzO9Q247oMcIXzX6Nw2u91muzWoN1rNHdb7MBvqB5rekoaNZRKdTNm2eON8hGqr3Rt8aPdb2xTtssdylIkaERvxKALMkDKkNdtyZZ9t1/DI58pnIEdYzGw9AqexL1fA/jjYkWy6vVqrXuvUBzfNHxutbmPQafzab3Yau9kJjXQiGguTQ0IX98ONpXIDD+IRjQz5DLwL6wJ8XyrtF6CJHFXEQ9YlhdFiDaWkOi154CL5w0BHEm+2eo1Oq3azlWdXQnCDdKqtcirppCZjb79Jq/Wx1Ma7SPWv6hVzKbjMpEAXl8JfFTOpEITnF+q5Kq4Fz+0Nlmqq8IkKAbccQr/7nRtr57T8crbW8uK8UkQtdHFehu+cK8GHWQkyr7S8Y56EKJwXGBPrahE+ojAUUE5NBSEPanZKhFkYBhz2JEzgWukUmFwPHzd7Wde9dZGzHW2t0Aj2Cy3yTSIg7rtMd+Sl1mNYIbby6S6QIG7tronZCUMN82zbyeXK9d5uSEAdSxdNmJAO73jAseVBXdNg80qhvMfg/PwGvbK9zhetDH3r+v78nP0uEzvFbCwin2HNB6Soyt5yFigaX58dag3SvvTlSBfhQs+FwMzC9+ioLsRKzJBkCwldZ2S/qZQ2dPGAqLjel3GpA+KMGa4mZK7PBsOQR9Ozd/dlVxwd0+htkb/7GH2MehvGaFYYWrnxKVaEOcHcQSs/0FAltrxlbVilVPmhgCJN0dFEERLmhi2QZsDnxGZiopwbOmFLEdGTAx4SimONKSrYoK9WIAVBdS8nifDJleBAKgLYNgZy+vfvf9h9hd3mjuwn62gz9NBpO2aAt83OVsPnD2VbPV5uNOQLXLPla+jZFOOQY/WCg5vJZTbqD97eqMOv6k5Em2m3r7ZPS5uBxwQFVjwAtUwHXYWrlX39KYG5PRdu5tqJgi+0vYfsjHmo6ZUMv+1kWv8d+6JT4MF88xmOFk5gnG56uJ1iot3h0x4Jv4rT/zwYfgXbl01YPcI80yJb1tSiNhpRbF747m00VvPWun/X7vZgbDVpW++mTu+yG3fKP0RsW8tylvZqi3rQZblM1RRrJLdPPx31WOtt1jGbAqT7P3EebTQ= +sidebar_class_name: "post api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Redelivers an outgoing webhook. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/release-management-api.info.mdx b/docs/release-management-api/apps/api-reference/release-management-api.info.mdx new file mode 100644 index 00000000..218072e7 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/release-management-api.info.mdx @@ -0,0 +1,81 @@ +--- +id: release-management-api +title: "Release Management API" +description: "**Looking for the old API?** You can find it here: V1 API spec" +sidebar_label: Introduction +sidebar_position: 0 +hide_title: true +custom_edit_url: null +displayed_sidebar: releaseManagementSidebar +--- + +import ApiLogo from "@theme/ApiLogo"; +import Heading from "@theme/Heading"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; +import Export from "@theme/ApiExplorer/Export"; + + + + + + + + + +**Looking for the old API?** You can find it here: V1 API spec + +The old API will be deprecated on February 1st 2027. Make sure that you have migrated to the new API before then. + +View the V1 → V2 Migration Guide + +
+ + + + + + PAT necessary to use API calls + +
+ + + + + + + + +
+ Security Scheme Type: + + apiKey +
+ Header parameter name: + + authorization +
+
+ + +
+ \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/set-public-install-page.ParamsDetails.json b/docs/release-management-api/apps/api-reference/set-public-install-page.ParamsDetails.json new file mode 100644 index 00000000..71c8f711 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/set-public-install-page.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier for the installable artifact.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/set-public-install-page.RequestSchema.json b/docs/release-management-api/apps/api-reference/set-public-install-page.RequestSchema.json new file mode 100644 index 00000000..5d0726e0 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/set-public-install-page.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"with_public_page":{"type":"boolean","description":"Boolean flag for enabling/disabling public install page for the installable artifact."}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/set-public-install-page.StatusCodes.json b/docs/release-management-api/apps/api-reference/set-public-install-page.StatusCodes.json new file mode 100644 index 00000000..ba844333 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/set-public-install-page.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Enables public install page for installable artifact","content":{"application/json":{"examples":{"200 - Enables public install page for installable artifact":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - No permissions to enable public install page":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}},"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Installable artifact not found","content":{"application/json":{"examples":{"404 - Installable artifact not found":{"value":{"code":"ERR_NOT_FOUND","message":"The installable artifact cannot be found."}}}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"examples":{"422 - Unprocessable entity":{"value":{"code":"ERR_UNPROCESSABLE_ENTITY","message":"Can't enable public install page because no install methods are allowed."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/set-public-install-page.api.mdx b/docs/release-management-api/apps/api-reference/set-public-install-page.api.mdx new file mode 100644 index 00000000..ee28e112 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/set-public-install-page.api.mdx @@ -0,0 +1,69 @@ +--- +id: set-public-install-page +title: "Change whether public install page should be available for the installable artifact or not" +description: "Change whether public install page should be available for the installable artifact or not" +sidebar_label: "Change whether public install page should be available for the installable artifact or not" +hide_title: true +hide_table_of_contents: true +api: eJy1V+1uGkcUfZXRSpVby4BNHFVC+RBxSIvqYATYUppYaNi9sBMvO9uZWQhF/O0D9BH7JD0zs2tMWFw5avwDL7tz7z3nzN1zh3UQkQ6VyIyQadAKLmKezkizZUwmJsWyfJKIkIlUG54kLOMzYjqWeRKxCTG+4CLhk4TYVCqGgHKhu8eVEVMeGoZnqTT14CSQGSluS3UjFBuS6bv8XR/VR3Ys0hTmSphV0Pq4Doy8IwD7eLu5PQkMn2lcB90HVdpFFR1gQcYVn5MhpV1wii+oIyJkFZZexk2M613OI+DOcxHdnDMRUYp0AswfY2SpKPojF4rAw6icgDqMac6DFiCvMltVGyXSWbCxwBXpTKaatH3ePD21/3ZBdFJbQVcKbqFUwQCKUKYGkG0+nmWIdOo2PmubdB3QFz7PkvuyrMa+qQ6iFzzJwWq9cX8nwfnp2T6J65TnJpZK/EnR08AhHcDtxD8oikyRlbQzGIyve+3r0a9Xg+7vnbeoMSetbdt8VXwL89k+zD6pudAaXxj2Wzwd6zNg7UmW3efRzEhGTtoqZQ9x6XcG77vDYfeqN37b6XW/IrQPs2CE6vvP/rcSpXDn+8J1q95uvNronDx9sorn4PEfGQ+Q6l2Nxu+urnu7ZEaH/CfkqU05IZ+1viXZbFY1caZkaLPaJNYPYEVPo9ZsumauyHOwqfuDq4vOcNh+c9kZd3qj7ujDDrcLnh6ZRzoM5EKea4J29/dhhLGMNHSAFkkil/SA+vMqE+qCokp5woakFvDAjlJSPY37c+cy1YkOkO/2Rp1Br325Q3goLXwYKFuiMlsq6by0QG/Nl7R5I6OVT/Yovj1rlpPP5OwTO4SX2AiPfSlMPPbijsvXtoiYSJkQT/dmxxt/n00TPnP+6bYIsBuR0P7qoNUeni4lTb+Dfm6FdnC5+dUKGg/CamWYbqxFtGn4arViRS0rZ6rdBz8Vc5Ugx3rCNV0PLjcNRaCgqTbnKRbPIWRj0WxASN1YnCF2wZVwQ8PqUUT53pnyPIHqQWxMplsNxIj6RGDuaaoLWTloPRBm0zDkYVZzp4TbJHLcb7dngKG76yoXJ4H7LUGx32hVTvaYeERqr2S/PWIpubdQraxJ23ek3e/CE5JEY3lxRChHh2sc57O2eQbbNuv4Hq9uE3sC2FggU+kACmNXBgMvLHt/L6wtbRXFVnh8i2b9bA/08fGllHe2dco2kThvIfT18TH7IHNraGwq0ogJw3BKoxZ7wVmsaPryqGo3oVQtkqFG20T0pR6befIaTaDrmRJz6NKDBi8LsD80T7dw8QVV8Xlzho+3SHHEDFczMi+PxpOEp3dHr27OnJ46o/BFg7/6lH5KR1vE2F+0PJw3okzBogxFDMPmHU1UbnfkTBvWPG3+XIdId2iCHF5lYm7YCjRjviA2FzPlwrB5VoqUli7xhCCOXUxp3RZ9VAGfBOrWZjjokZOggopAblsDnP75629202Tvy0D2iw20DAPsdCa1QXq72UUDfeeD806DPDC87123eNcMfTGNLOF41cDeGci6MKOPQaUZIbblzt1VfoQXPIaCNnjtfUglm429jfdN2YP/7dZ2nGd5N7XHnClPND0iyI+D4mD+E/u2g30l5dJz0pUzRDfEAlzewYHcD4zNLVYVJmQB+wcXHlZtZMO3gXtDanNSRrTDkDLz6NrbB4MB/nbxK1ZPikk492NV8aX9iYJPh1I6nZyLunvrAA0/y/2k9Umt5VkT3DXYO2ewxYX7OValw655lqLYT8urMmS99vaNXS/X+0cHI+4NvpDcCgHU/wLgAx6C +sidebar_class_name: "patch api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Changes whether public install page should be available for the installable artifact or not. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/sidebar.ts b/docs/release-management-api/apps/api-reference/sidebar.ts new file mode 100644 index 00000000..bb056e2d --- /dev/null +++ b/docs/release-management-api/apps/api-reference/sidebar.ts @@ -0,0 +1,240 @@ +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; + +const sidebar: SidebarsConfig = { + apisidebar: [ + { + type: "doc", + id: "release-management-api/apps/api-reference/release-management-api", + }, + { + type: "category", + label: "Apps", + items: [ + { + type: "doc", + id: "release-management-api/apps/api-reference/list-apps", + label: "Get a list of apps", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/create-app", + label: "Create an app", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/delete-app", + label: "Delete an app", + className: "api-method delete", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/get-app", + label: "Get an app", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/update-app", + label: "Update an app", + className: "api-method patch", + }, + ], + }, + { + type: "category", + label: "Public Assets", + items: [ + { + type: "doc", + id: "release-management-api/apps/api-reference/get-public-asset-status", + label: "Get the status and reason of a public asset", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/generate-public-asset-upload-url", + label: "Generate a signed upload url valid for 1 hour for a public asset to be uploaded to Bitrise", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Installable Artifacts", + items: [ + { + type: "doc", + id: "release-management-api/apps/api-reference/list-installable-artifacts", + label: "Get the list of the installable artifacts", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/delete-installable-artifact", + label: "Delete an installable artifact", + className: "api-method delete", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/get-installable-artifact", + label: "Get an installable artifact", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/set-public-install-page", + label: "Change whether public install page should be available for the installable artifact or not", + className: "api-method patch", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/get-installable-artifact-status", + label: "Get the status and reason of an installable artifact", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/generate-installable-artifact-upload-url", + label: "Generate an upload url for an installable artifact", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/get-what-to-test", + label: "Get what to test information", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/update-what-to-test", + label: "Update what to test information", + className: "api-method patch", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/list-custom-access-links", + label: "List custom access links for an installable artifact", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/create-custom-access-link", + label: "Create a custom access link for an installable artifact", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/delete-custom-access-link", + label: "Delete a custom access link", + className: "api-method delete", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/update-custom-access-link", + label: "Update a custom access link", + className: "api-method patch", + }, + ], + }, + { + type: "category", + label: "Presets", + items: [ + { + type: "doc", + id: "release-management-api/apps/api-reference/get-presets-list", + label: "Get a list of preset templates", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/create-preset", + label: "Create a preset template", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/delete-preset", + label: "Delete a preset template", + className: "api-method delete", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/get-presets", + label: "Get a preset template", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/update-presets", + label: "Update the preset template", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Apple App Store", + items: [ + { + type: "doc", + id: "release-management-api/apps/api-reference/create-draft-version", + label: "Create an App Store review version", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/get-draft-version", + label: "Get the App Store draft version", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/update-draft-version", + label: "Update the App Store draft version", + className: "api-method patch", + }, + ], + }, + { + type: "category", + label: "Outgoing Webhooks", + items: [ + { + type: "doc", + id: "release-management-api/apps/api-reference/delete-outgoing-webhook", + label: "Delete an outgoing webhook", + className: "api-method delete", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/get-outgoing-webhook", + label: "Get an outgoing webhook", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/update-outgoing-webhook", + label: "Update an outgoing webhook", + className: "api-method patch", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/list-outgoing-webhook-deliveries", + label: "Get a list of outgoing webhook deliveries", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/apps/api-reference/redeliver-outgoing-webhook", + label: "Redeliver an outgoing webhook", + className: "api-method post", + }, + ], + }, + ], +}; + +export default sidebar.apisidebar; diff --git a/docs/release-management-api/apps/api-reference/update-app.ParamsDetails.json b/docs/release-management-api/apps/api-reference/update-app.ParamsDetails.json new file mode 100644 index 00000000..7bd70522 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-app.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier for your app.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-app.RequestSchema.json b/docs/release-management-api/apps/api-reference/update-app.RequestSchema.json new file mode 100644 index 00000000..44fdbeda --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-app.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"connect_to_store":{"description":"If true, will check app validity against the Apple App Store or Google Play Store (dependent on the platform of your app).\nThis means, that the already set or just given store_app_id will be validated against the Store, using the already set or just given store credential id.","type":"boolean"},"store_app_id":{"description":"The store identifier for your app. You can change the previously set store_app_id to match the one in the App Store or Google Play depending on the app platform. \nThis is especially useful if you want to connect your app with the store as the system willvalidate the given store_app_id against the Store.\n- In case of iOS platform it is the bundle id. Check the [property description](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleidentifier).\n- In case of Android platform it is the package name. Check the [documentation](https://developer.android.com/build/configure-app-module#set_the_application_id).","type":"string"},"store_credential_id":{"description":"If you have credentials added on Bitrise, you can decide to select one for your app. \n- In case of iOS platform it will be an Apple API credential id.\n- In case of Android platform it will be a Google Service credential id.","type":"string"}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-app.StatusCodes.json b/docs/release-management-api/apps/api-reference/update-app.StatusCodes.json new file mode 100644 index 00000000..20336f0b --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-app.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"The updated app","content":{"application/json":{"examples":{"200 - The updated app":{"value":{"id":"50590a63-799c-4bc7-99e2-c3b2363b22d1","created_at":"2025-02-11T09:26:01.000Z","platform":"android","project_id":"23c9f973-6b65-4aca-945b-a6eb4a0a9913","workspace_slug":"workspace-slug","icon_id":"dd6fadd2-6e4b-4bda-b6e2-aa319cdc89cd","icon_url":"https://storage.googleapis.com/rm-public-assets-storage/apps/50590a63-799c-4bc7-99e2-c3b2363b22d1/app_icon/dd6fadd2-6e4b-4bda-b6e2-aa319cdc89cd/icon.png","app_name":"Test Android App","current_user_release_management_admin":false,"framework":null,"latest_version":null,"latest_version_date":null,"latest_build_version":"","latest_build_version_code":"","license":"basic","store_app_id":"android.app.name","store_connected":true,"store_credential_id":null}}}}}},"400":{"description":"Invalid store credential id","content":{"application/json":{"examples":{"400 - Invalid store credential id":{"value":{"code":"ERR_INVALID_STORE_CREDENTIAL_ID","message":"The given store_credential_id is invalid."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Store app id cannot be found in Store","content":{"application/json":{"examples":{"404 - Store app id cannot be found in Store":{"value":{"code":"ERR_PACKAGE_NAME_NOT_FOUND","message":"Package name cannot be found in Google Play Console."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-app.api.mdx b/docs/release-management-api/apps/api-reference/update-app.api.mdx new file mode 100644 index 00000000..e60d47c6 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-app.api.mdx @@ -0,0 +1,69 @@ +--- +id: update-app +title: "Update an app" +description: "Updates an app." +sidebar_label: "Update an app" +hide_title: true +hide_table_of_contents: true +api: eJyVWOtu20YWfpUBF0UuMHWz7KyEpoXqqKlQxzZk2cA2NYghOZImpkh2ZihHFfR3H2AfcZ9kvzND3Swq6wQBTZEz53znnO9chksvFjpSMjcyS72ud5fH3AjNeMp4nte8Ey/LheL0dhBv3vfyHG+0iAolzcLrfl56JnsUEPD5YfVw4hk+0bj3sE57+J1zxWfCCKXt2hQ/IEvGECJJa87NFPf7UEZTwYpCxvdtJmORGjmWQrFxptgiK9QanhJ/FVIJYDOqEAAVTcWMe10gWuSkRRsl04m3IlxK6DxLtdD0vtVo0J8KpdbGmDRAQZSlBtppKR4kMrLOqH/RtH7pia98licbicxnz0XgxZwnhaAbST48a5x1Gvz81H/X6UR+O4ze+Z2OaPnRadg6PcelFTdJsRIkI+DQDdGtM7/R8pvNUaPTbZ13G81ao9H4A+vyhBt4ZYZVPI1VZt2aq+yLiExgFbZOo8648+7UPw/Pz/w2j7jfaZ+FPj8XYZs3eKfTPMWep0w96pxHItBJMcG+zQPfPkCw4AwnMo7PxzyOW/65aIewIeZ+eA4bOD9tdqI4+icu6w2FSrBjakyuu/W6NpniE1GbZNkkETyXuhZls7qa+XkRwr0+11oY7Zfr6nChrr/EZbQyIIX1l4Cr08panpJZtLHk5Ehow3rOjczRHCRXIEBQaKECJYBZi2DGU4Cb0XMez4jEY55o8G9MTCfHed20SJITL6F8MsEc5LcUq3oaEFuevQoLmcTbbZ5X/SaIsliUr2UkQG78CLmWEWUofCgC65d4S48apY61d70CrkjBlp0sco+RV5R4PLH7Cd7K/jvx2lXJM0hBdPjN7mbb3cxS8jsSqW0T6VvidpOq9EB/OAwGV/e9y8GH4HZ0PewHF8P+h/7VaNC7DAYfgGAmtEbUyjSfyLlIWYWlTGomne6atzW4eWjwXcoLM82U/Ft8t4VNWLi3/4hJd1e9u9Fv18PBH/19G/Y2b2GeHsK8EWomNbGFwUr5/VhPgfVQyBHAN/3hp8Ht7eD6KoD3B89QH4rZQm8fQr+1sQdCBJ1FPE0zw0KBLlCkiFPK7PvvNacNc14m+JiJvYvfex/7wVXvEy7Xo+DX67urZ3by6BF3jPKsSv5HW/7YTcIX7AI9KUvElmxn1dmFBpqC/rdCIflZX6lMfZ/pZ2VeVQk6mlGj/vCqd7ln3G2Gbj5FW2VP0MyeVGY7bImeWjLq1C9ZvHDCvonvoGFnIXUu18MwexjpsJc1KjBZoNexeeagMbPViz3JJGEQGz3aANtMxpzC+ITLFPXdIPtR2xN7LZmAsWI3JO7h61jkIqXKwMBX2rZutiwbb8aQN7U/09EURWMmeKpPsI47HTxBC48XDP2M5H8poHu36rjC7OCCGxanGxt2gFokJ6zQ5O4XSN0vlDQilX4NM3CMp97qeV+omoGcqGNzF/tXVhCp4WSeguTWM0rMZVboxCHbs9BkbMZNNLULs1RQApRBqHa/8ztZXPqd4rj2fY2V/sZ/DHQigqnQiv48LmCzDQx74gga9Ja02WCHt43D4Uzk2v1YaCNmNhTrMNjnFeE6CA7CT0kFh2hBvJDXt1ueSEMwaW2IzE/IpzV2YblJDz+XJCeTNzF4eL0elmIxFwktoJ6NCkGTUpxFBQ0eLo2cVAy2sC8Sui5TUmvfBWvZQSK1qUdjt3Yb1DfPka8Hnwr0+U492zNgD04l8nLqIOx2dKkjJmM5KZTwYZU/y+IiEf8AaQIIDHZqBLz9ZofA60n+yHhSUQ6ICFM+380JHG3iGCkGXv0iIRAzm11GbI5BpVgQazTGvMhYqu4T//+Eep3KEFYWmJvBs4R8gcs3UtY5QYUaw93R1N6ccVwBpuKcxe5cFdHByp6vul59KeOVPbhR3XdnMTecLzExirvh5apeDrj+dsCtz1tuCJ/TqWTOleRh2U/KXc73Y14kZmfQx2hfC52LazKrPN45IIzEMMjZyU1qCq4hPmwPmrf2qdVcHjc3TQPKfheL9XlyigIp1IHKm96IoRhQG1MLCjNKhosQCojG8vIQsJ6rLAk98ig1q+G2rfVdT61uS7sT9Gb0LiN0hLo71Kb8tXZJQwq8oYsH+7SJByGmQGxOBvNWrXlg69u3l1n2SBWUCGzrbhLT1p/fvt2U77GkYcSwKQpIl/3I2VSJ8ftXVSSAg32kOhWYWHytTc0s+Rnc0bVcyRnceQXXvS/B/tBqbOHiB7Tiet/E5QNEvGKGq4kw718FYcLTx1c/3TdtGKiW/1jnP/2ZUoHfIN7kA7qCEpHtkEjfX0WoCgpkE8UY5+N3NTjpEdxBYXE9eJP+MzlRdhtiTq5IxZMVHIpxZheLtEZKv+kBJwTe9ScFyoR1QYUpErJJB2z677//w+5b7NN6I/tIG8lCinSeaQPxFOySd/sfX56HdGeSqvhMU+aBEV9NHbVE2j5vk3tZpv9nrwuuIZ2mUEw/ly7rFQ519BjsVvQt52Gb5LZCxFLTfbw54h5F9XpYfox5w1728aYS9Dqj04UtN3YkpePtI/LbfjRaPWBVmeIE0L24cDD8EW3fbjwYOVcn6x29KBK5+ebah51iiupx8RtWh+VcO3NDsuJP9BkKV4sys36xNco+W+LUnk4KNzc7oVRQqMTsl69HW77KG/tFrcoP+6Vp7RS6kl2VW5ZLVxxXq8169+rojk35LF1OjgDq/wFCXvcv +sidebar_class_name: "patch api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Updates an app. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-custom-access-link.ParamsDetails.json b/docs/release-management-api/apps/api-reference/update-custom-access-link.ParamsDetails.json new file mode 100644 index 00000000..a8dd24f0 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-custom-access-link.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"installable_artifact_id","in":"path","required":true,"description":"The uuidV4 identifier of the installable artifact.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The uuidV4 identifier of the custom access link.","schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-custom-access-link.RequestSchema.json b/docs/release-management-api/apps/api-reference/update-custom-access-link.RequestSchema.json new file mode 100644 index 00000000..d363fa73 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-custom-access-link.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"A human-readable label for the access link. Existing value is preserved when omitted."},"expires_at":{"type":"string","description":"ISO 8601 datetime string after which the link will no longer be accessible. Pass null to remove expiry."},"access_code":{"type":"string","description":"Optional access code (8–64 characters) required to unlock the install page. Pass null to remove the access code."}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-custom-access-link.StatusCodes.json b/docs/release-management-api/apps/api-reference/update-custom-access-link.StatusCodes.json new file mode 100644 index 00000000..96d199b3 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-custom-access-link.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"The updated custom access link","content":{"application/json":{"examples":{"200 - The updated custom access link":{"value":{"id":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee","name":"Updated link name","created_at":"2025-02-11T09:26:01.000Z","expires_at":null,"url":"https://app.bitrise.io/app-install/example-token","creator_email":"default-user@example.com","creator_name":"default-user","creator_avatar":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"}}}}}},"400":{"description":"Expiry date is invalid","content":{"application/json":{"examples":{"400 - Access code is invalid":{"value":{"code":"ERR_VALIDATION","message":"ReleaseManagement::ErrorHandling::ValidationError","details":{"access_code":"Access code must be between 8 and 64 characters."}}},"400 - Expiry date is invalid":{"value":{"code":"ERR_VALIDATION","message":"ArgumentError","details":{"expires_at":"Expiry date must be a valid ISO8601 date-time."}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to update a custom access link. Only Admins, Owners and Workspace Admins can update custom access links."}}}}}},"404":{"description":"Installable artifact not found","content":{"application/json":{"examples":{"404 - Custom access link not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}},"404 - Installable artifact not found":{"value":{"code":"ERR_NOT_FOUND","message":"The installable artifact cannot be found."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-custom-access-link.api.mdx b/docs/release-management-api/apps/api-reference/update-custom-access-link.api.mdx new file mode 100644 index 00000000..53b776b7 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-custom-access-link.api.mdx @@ -0,0 +1,69 @@ +--- +id: update-custom-access-link +title: "Update a custom access link" +description: "Updates the name, expiry, or access code of an existing custom access link." +sidebar_label: "Update a custom access link" +hide_title: true +hide_table_of_contents: true +api: eJytWP9u2zYXfRVCwNCtsGQ7TbvOWLd5bfbVWJoEjpNh6wKDlmibsyTqI6m4mWFgf+0Btjfck+xcSrLlWG6QoULgyBZ577nn/qRWXiRMqGVmpUq9nneVRdwKw+xcsJQnosXEh0zquxZTmvEwFMawUEWCqSnjKR5KY2U6Y2FurEqqFbFMF4HX8lQmNCfJg2gj+7Vb2XcLT7EOy4wIcy3tndd7v/KsWgggeX+zvml5ls8M7r1BaiyPYz6JBetrK6c8tMbDgoxroLRCG7eZIEOT3C4f83L5WEZQJcnIjNs57rX4fy61ADSrc9G6x8QIDOS5jK6PmYxECiFSaDKbqKkpYJUCMtiEc5Fwrwcz7jJCYqwGPd563dqC+4Q4mmk/jOKGtJlMpUYYen7U6dC/Bo3OV1GDAsgPVWqBhHbyLItl6Hzc/s3Q9pUnPvAkizcKmM8ekIh1tzzOBd1IihReXv4Elx/i8iNcvqhdwFESelVKJlkuaAmiFvTbmAMlQBw99ztHfrc76nzVO3rR63SDTqfzC9a56BbGrUvzOG55uY6xZW5tZnrtNuwLJhL0GRFIRV/90vft0ky/CNhSpdJjUC9JRCSmPI+tnxuhvysXB6FKaktLA+ora0/5Lbdc18CUQPwsn4B0v3SDn2kV5SG5IDDPAp7w31XKl4Z0tUmkL7HStAtxfqksyFxA0NXyjpvC4MQlPiNumTQIefjIxe4j3H/s3N+v1Y2apLrb6RnpHA7H1/3TwZv+aHB+Bl0JNvIZPRqKWHAj3vEU3xPo7/VOtFb6LU8jeH7W612TVIfFPfAokyx84ZAU8TYu9dQRJQhINhH4s0shUvYShS1iL45ZOEdxCam2BF5FE6w5wMvjrOnrWU5GNCCth+SOEyqgnDmNbHB5/vJFp+se+lYmIigd6qB29z16lfLczpWWv4tH+7ELy3f2H7D36qx/NXp7Phz8cvJmx+KdzVuYz/ZhXgidSGPwhaHgycdjfQas+0IOAL44Gb4bXF7CQeM3J2eDe6h/Vjmb81s0Q8WyjUj0R1UWNHijoQiz8zS+Y/0oQbFosfNliiByYfWT0guT8VCUD1mILlpK2pdjghpTx/tMDRraEJBaNlV5+mjajkHb6z0MNXkHGDw7H41/OL8622WOaj7CWOUaxsJKEoPgLSSVFkHhAyY8WmVTZ76vfsvq86bCNwBnOuUxuxT6Fr22ytFHkPncVYpmQQdMGpyNToZn/dMdiy4Vhps5DVhLaGZLrTZVe10MDsLY71V0Vwj7KL69qUBNfhOhhT40EMS2lQX2oindnx3ujyV9Ns8TnvroVZEjG5SLGPxqN5jsJMNJNSU6u6loZogM4iRiyzlKrkqkRbeGX3Y78kMgUAHZpgRSBWTFQsanYB6yZTh3cFwgL2UcUx7HIBFPJxVKCfgBu+DASyMA5bYWiULSF7Ovg7XTPx7Cde5u4Pj6xPz5y3/++HunrXzBqtHP1ZM0VuGiPl6yDFHQjKzGMQnfRjTFi4qK4TKk6dINmT2vXUsMv0oM014dGJXX7aIa+YUS31UjrI7Wbl6ncC4m7mJcWk3Qmq+Gp+u2Ltq0n2z6dPv2iOYm077tYu8t15KUuVArdxUp6MaSndFL1kavPY4p2QsgjMQwyIGHbeFvF+sFKzfb88Wl+9VpLk8ZG0dC2Y/irhrM5whqofdUXvRHLBXEB0dPJpdBb/9igPoSo3dvBtKq0bn8c7WOcnC4zdaTolRss20bSDvdf/Pr7vRSjfOEdqqcFdLGtSGJbackwke0w1+FEbdHQXfPsqdPT5VaUOZUCaziiLZ++/Qpox5IbWoq0cCkZXOhRY99zdlci+mrJ00uB51+pEKDqIvEh2Buk/hbRIoJMi0TkHcGq1+VYD876mzh4gu04vO6i483EPGEYWqdCfvqyXgS83Tx5JvrriPdZCL8us2/+TX9NR1tERdpjuSOBKpM6E4GGAJ+EBOdk9u6GKJwIPgyAEkLREquKZu4ZXdVq0/kTLtt8LA7B4ulEzwRIMelXhqQ0o8yUAgBu/4MhzfhKGgwRUI26YBN//z5F7s+Yu+qjex/tJEsJE9nyliIr4VMdVRvGkDuO7jWHD7xEb/MHys+2HYWc6TPujxDrcrS895rLD3Y2zt8Tm+oPm5DRIf+Obgguaui7Oh4vaafkV6a3iHcbKuMK1GRNHSPojjlsbl/wK5T8/mwrMdfsP90/G8ko6ow6Z0rf67ze7hdoN4cflVBLww+PfBH+PAB2EB4g1VlpSSaiwevy0PpiLZvN+4NJGRfsYPOYpn96NqbWl9DEX79Fqsn5dSTFDVR8yW9SsGnQ6kcSa7Uu99WHhJulhdTVSGU6jJV6t0usHBdoLxx76OaeNit8BUp9El2NW5ZrYoes15v1hePDu7YdKEqUojy9fpf5ynRNw== +sidebar_class_name: "patch api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Updates the name, expiry, or access code of an existing custom access link. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-draft-version.ParamsDetails.json b/docs/release-management-api/apps/api-reference/update-draft-version.ParamsDetails.json new file mode 100644 index 00000000..9154effd --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-draft-version.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-draft-version.RequestSchema.json b/docs/release-management-api/apps/api-reference/update-draft-version.RequestSchema.json new file mode 100644 index 00000000..09a1a445 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-draft-version.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"app_id":{"type":"string","description":"The uuidV4 identifier of the app."},"version_string":{"type":"string","example":"1.2.3"}},"required":["app_id","version_string"]}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-draft-version.StatusCodes.json b/docs/release-management-api/apps/api-reference/update-draft-version.StatusCodes.json new file mode 100644 index 00000000..9a9c0128 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-draft-version.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Updates the draft version","content":{"application/json":{"examples":{"200 - Updates the draft version":{"value":{"id":"app-store-version-id","app_store_state":"PREPARE_FOR_SUBMISSION","version_string":"1.2.3","release_type":"MANUAL","earliest_release_date":null}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"No App Store version exists","content":{"application/json":{"examples":{"404 - No local app version exists for the target version_string":{"value":{"code":"ERR_APP_VERSION_NOT_FOUND","message":"Could not find related app_version: version-without-a-release"}},"404 - No App Store version exists":{"value":{"code":"ERR_APP_STORE_VERSION_NOT_FOUND","message":"ReleaseManagement::ErrorHandling::NotFound"}}}}}},"409":{"description":"Draft version is not in an editable state","content":{"application/json":{"examples":{"409 - Draft version is not in an editable state":{"value":{"code":"ERR_CONFLICTS_WITH_CURRENT_STATE","message":"The App Store version's status is not in an editable state.","details":"Either complete the process in App Store Connect or cancel any outstanding reviews so that Release Management can continue the release flow here: https://appstoreconnect.apple.com/apps/1234/distribution/ios/version/inflight."}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-draft-version.api.mdx b/docs/release-management-api/apps/api-reference/update-draft-version.api.mdx new file mode 100644 index 00000000..8827921d --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-draft-version.api.mdx @@ -0,0 +1,69 @@ +--- +id: update-draft-version +title: "Update the App Store draft version" +description: "Updates the current App Store draft version—the latest unreleased version that can be submitted for App Store review. A local app version with the target version_string must already exist. - iOS only" +sidebar_label: "Update the App Store draft version" +hide_title: true +hide_table_of_contents: true +api: eJzdV9tu4zYQ/RVCQBEg8CV2UhRr7AXexOkaTRxXtlO0u4FBS3TEjSyqJJXENQL0qR9Q9Av3S3qGkiwnjoPmtXlwbImcOXNm5gy58kJhAi1TK1XidbxJGnIrDLORYEGmtUgs66YpG1mlBQs1n1t2K7TB6m9//kOrYlpvWZZoEQtuRFi+hw1uWcATNhPMZLOFtBZv50pvWNTiVoq7BuuyWAU8Zhxvyv130kYOiOX6Wqz9To3VMrlmiwxueawFD5dM3EtjG6zO5MWIqSReejVPpUJziqsfriM7oQguc0NYYgSClHbpdT6vPKtuBDj4fPVwVfMsvzb47gFqLCrAHl6lXPOFsDBCi2ueFiZViRH4ufLaBwf0bzerjzgEhEAlFizTJgQfy8BBbn41tHPliXu+AILSNiLcbQxLbnmcCfoiKWYYrBuCXS+W1PG4Ro+n7jE+YQoLh35v2PV709MLfzqafDzvj0b9iwGWPuYcK1uNduPQo6Bdtqd2mZKB8+5g0j3Dc8F1LFEQ03JB6DwkWRw/uL+ad3TQeoaihGc2Ulr+IcLXsQJzxMrm/k0iAhUSwJ7vTyeD7mT86cLv/9Y7gY+FMIZfi6fOK5iH2zCHQi+kceUZikS+HushsG4b2QF42POLVExPeoP+E9TbZiroR9vQB2qj78oec31jXhvEEYKAue2Wzc25Ht/ZuLuC7Q6H08ue76IdXIxRi5PB44CPVRaHLFGWzWUSQjtIe0ICMC1cdEpfdRIPldk6rxeF6BXE5NB3MvECuNH4Ai3yMkQ/d3bOE/xegNBOp6e10p94EsYIvtMZKHuqsmQzWW+2k3Wy2dhMGhe1TBjUVITS8hlEKW/eV6buDeL/78Z3sHF8MTg96x+PR9Nf+uNP0+OJ7/cGYxDUHfce0TGOxDbVe8ZZz8xLrhuwEwrLZWzIKbIpNAsURWKFK65UqwCOaHfl4lgliQgsQwFi8gQC5ZksGQoBRpOQxkY+cQBB5QOqyBirUuZmFpEqkyx3VZQQm8fqjgGI6LDI2tR0mk0w7qQ0yB03KAOiAaDuTbPVPjxqhpIqf5a5tEhlmgURTZnMY3kd2UZVDK32djGMCDvXIUNuBQYN8PyeSf1q8Wm1kfzdxnYkG1kdnHT9kyky3huMelO/9/Ok7z8Ro3GEZM5EIubSliYN49vuSm0oCMv7tyLg++fmZx8x6gRaMxIa3DHXUq8L/ns3O583tCPw/mDc8wduqlVxjhRGf0SFdEelcqcVFO2hRE+BY/h9VOEyN/YiPhNEYsHpWzFF1ewrKIE/1DYOL1bm2EngZLixrhDS2hOaqNuyTIaXR0xiIlg5l4hRzR3fOcvbE33baEHbetiXgeVF8rmEs2XqKueA+FF0+ki5DSIKhtsIP5uuNerrMwn9Ls8lpulOMu5ERokx7kCW6Rj7VjO03sQ/e2gWbVhfrFu1edvO++y2RXi4lqQgjrRiV15Mc57FSINXda1szCRgG9GQ6lkicyCMzDDYqU6jLmvCVexVdYIcuafOc3GOXBMLZz8JOpBKsh3hvCr0lsthd8zQD1RnesmsYhn8dod9iFEc04BOcOYkY8VBxVWSSw1Vk1/VXa/MXlU3VWp3HOceCNtcOczSxhuDbFMWgaYygSW37UZrK479/TOlbqg/ykZXmNnY+mF/n/2qMieubnxDJ3IpfctZpMX83d5zCQZ59VAFBloZivtGZBfxB9SFaaRaLkDVALS8K8B+1z6o4OIHvOLzsoWPE5jYK84j7/ams5gnN3vvL1uOYpOK4G2Tv/+SfEnGFWKkPI7p8hKKFALvzhqYl6dipjNKUgv3j/ZB+4cGSLqhK44W+UhZIsyI3wq2kNfabbPKUZGIO2d4JubKLRZJg5y+yEBuhM401+ht4Sh4JhQMNecDMX3762922Wbn5Ub2I22kCCnTqTIW5inZRU1t3ih2XPae5nlD2/5Xd8aiZa24t8005uhYMOZ0aFXomNO/TR3LL1RrJSOmnJZBHCJQTTtWuYZpXIHoMXpVL/O7YylZ7tpZK8WBxO8GkkFHXsdyfUy4auWY2p4mD7VyRzcIRGpfXHu1IdLQneNPWD0rRtYin3+a39ElD58dz12lrYsNC9yzlYequ87ykZgbJSkicXosfDdO+Iov7pJdvEqWmxAfiVqtiIQ+Ka5nt6xWuayC0XJ9/mrnjrXw5qsptTSx/gVQZ+Z1 +sidebar_class_name: "patch api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Updates the current App Store draft version—the latest unreleased version that can be submitted for App Store review. A local app version with the target version_string must already exist. - iOS only + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-outgoing-webhook.ParamsDetails.json b/docs/release-management-api/apps/api-reference/update-outgoing-webhook.ParamsDetails.json new file mode 100644 index 00000000..89ded920 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-outgoing-webhook.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the outgoing webhook to update.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-outgoing-webhook.RequestSchema.json b/docs/release-management-api/apps/api-reference/update-outgoing-webhook.RequestSchema.json new file mode 100644 index 00000000..f0212c46 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-outgoing-webhook.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed","app_store_release_cancelled","app_store_release_completed","app_store_release_started","app_store_review_approved","app_store_review_cancelled","app_store_review_rejected","app_store_review_submitted","app_store_version_created","app_store_version_updated","app_version_added","approval_task_added","approval_task_changed","approval_task_completed","approval_task_deleted","approval_task_reopened","approval_tasks_completed","auto-upload_disabled","auto-upload_enabled","automation_added","automation_removed","google_play_automated_rollout_cancelled","google_play_automated_rollout_configured","google_play_automated_rollout_paused","google_play_automated_rollout_resumed","google_play_release_completed","google_play_release_notes_localization_added","google_play_release_notes_localization_changed","google_play_release_notes_localization_removed","google_play_release_started","google_play_rollout_percentage_changed","google_play_testing_track_release_completed","google_play_testing_track_release_failed","google_play_upload_completed","google_play_upload_failed","google_play_upload_started","metadata_localization_added","metadata_localization_changed","metadata_localization_removed","microsoft_teams_connection_changed","outgoing_webhook_added","outgoing_webhook_deleted","outgoing_webhook_updated","phased_release_disabled","phased_release_enabled","phased_release_paused","phased_release_resumed","release_candidate_auto_select_latest_build_disabled","release_candidate_auto_select_latest_build_enabled","release_candidate_build_selected","release_candidate_source_changed","release_description_changed","release_settings_changed","slack_connection_changed","stopped_managing_release","testflight_app_review_approved","testflight_app_review_rejected","testflight_app_review_submitted","testflight_distribution_start_failed","testflight_distribution_started","testflight_distribution_stopped","testflight_processing_completed","testflight_processing_failed","testflight_upload_completed","testflight_upload_failed","testflight_upload_started","testflight_what_to_test_added","testflight_what_to_test_changed","testflight_what_to_test_deleted"]},"description":"A list of event names that will trigger this webhook. These events correspond to specific actions or states in the release process."},"all_events":{"type":"boolean","description":"Indicates whether this webhook should be triggered for all events. Set to true to enable the webhook for every event."},"webhook_configuration_id":{"type":"string","description":"The unique identifier of the webhook configuration that can be found in the workspace integration settings."}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-outgoing-webhook.StatusCodes.json b/docs/release-management-api/apps/api-reference/update-outgoing-webhook.StatusCodes.json new file mode 100644 index 00000000..04132518 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-outgoing-webhook.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Update outgoing webhook","content":{"application/json":{"examples":{"200 - Update outgoing webhook":{"value":{"id":"75be346f-2e70-44c9-95af-7dc7c8f0c48e","created_at":"2024-05-09T15:52:21.000Z","events":["release_candidate_set"],"all_events":true,"webhook_configuration_id":"5623239f-28ea-4b8d-856e-8cb50073fade"}}}}}},"400":{"description":"Webhook configuration is not associated with the workspace of the app version","content":{"application/json":{"examples":{"400 - Webhook configuration is not associated with the workspace of the app version":{"value":{"code":"ERR_INVALID_WEBHOOK_CONFIGURATION","message":"The given webhook configuration is not registered on the workspace."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Webhook configuration does not exist","content":{"application/json":{"examples":{"404 - Webhook configuration does not exist":{"value":{"code":"ERR_NOT_FOUND","message":"Webhook configuration does not exist."}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-outgoing-webhook.api.mdx b/docs/release-management-api/apps/api-reference/update-outgoing-webhook.api.mdx new file mode 100644 index 00000000..16294241 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-outgoing-webhook.api.mdx @@ -0,0 +1,69 @@ +--- +id: update-outgoing-webhook +title: "Update an outgoing webhook" +description: "Updates an outgoing webhook associated with the given app version." +sidebar_label: "Update an outgoing webhook" +hide_title: true +hide_table_of_contents: true +api: eJytWf1u2zgSfxVCwKF3Rf0Zp0mD7S6yjbs1tnV6jtPFbTcQaGlssZFFLUklzQb+9x7gHvGe5GZIyZIsOU1w7R+uQw6Hv/keju+9EHSgRGqETLwT7zINuQHNeMJkZlZSJCt2C4tIymvGtZaBwO2Q3QoTMRMBW4kbSBhPU3YDSiOPrvfC0xBkSpg77+TzvWfkNSDnz1ebqxee4SuN373zgvdvjrf2cFOmoDjhmIRbJAVhTofMU674GgzeZtkn+AdSixC3BEmQchPh97pYc4SaZSL8NGIihMSIpQDF5NLK0BDUSJbZ20kYBX9mQgFCMioDFC6IYM29E5TsLqWrtVF42NuQfAp0KhMNmvaH/T7916bgxp14USATg9DoCOozFoHVRe+LpnP3Hnzl6zTecmYdto8VEtzwOAP6IkiVR4cLOBi9XHaGcNTvjEbBq86rQ77sHIXBUXC87AejYyAACsi4PkcMeMVw1Okfdvqv5oPDk8PhyXDQ7ff7vyMdoMmNNaOCGLgGP+BJKAiMr8GQKXkc+wWZU1sOzkcpl2KVOUP7Ft7hy+HB8OAVwjsG3hktjsPO8eFL6BwHi8N+/+hgyUNA9dK/F96oTam5d7AacyY0S6Rpddtbqa51ygMofKDiwU8zxcia4vsCqBowkCE52Xg28yfTT6fvJ2f+b+Of352f/+q/OZ++nfxyOTudT86niHoNWvMV5O7uIvP2IWAKVkJjJCEwXKzB6lYUPmjx4oRnJpJK/AXhU/U1INetnt8j7uX09HL+7nw2+X18VpOudriEedCE+RHUWmjSKcOoF0/HeoBYm0z2AP44nn2YXFygMfyz8XSyg7rJpoQ+eqxLhxKc6eArWu6p0oz2euoO3z0CTs/n/tvzy2ldsMdwrLjTYNgU9sJgAuEqZCgAYPpk26T7NAkHQ5RwP7M9Yl3MT6dnp7Mz//3kzXh6MfZn439eTmY79ptHGDULSGApTMES62TzuqVUNpYQeAIBRT3iLhVw2JbAJiijSnjMLkBhFmBjpaR6mvCHNhG1M9qbUObj2fT0fU3OC4nVNXL1JDHsVklb3HL0JDho87MM7xyzB/E1aqVcfEGVUBVXVO2NcNiLUrGl40rxO6roBtbV9bzWYg1KsvX+CoSNBoJcxmIVGT9LY8lDfykSoSPrUispVzH4aczvfG2kghaaBRjuK7gRcOujaEreNJYVfLH2tU2Cg4G2J2pkjp85b4KCoP2VkllaocXy1wRSEBvFA2oK3NU81lg4ydTuOp0t1sJQraYLHRzL2eJCXQQQxzkwu6QNNxnyiHiyqgHGDVUXAc2CfoyNGrSQV0GUElaMsL24ZffBsyWQ6t6u+ht7+67cNVBjb6vC2mZegf28FWrdc61hsVes8jAs1qzBfMP19Z7VUq8763UNVXZCaF9XgGGUNDfq7oLlUnZyFw+F5ou4sQxJdXXturMt+nJJwTo3RdV3cwL0RyXjGBvSml2+QZmXjUeQpjzTjyDDvJytG3Rtbti2jzULtB/LgMfir7oeHklemveRB9qV2oyM2m6hk7ZwrRLWMso3tdBOveSiacrcc/ZxKlLqA0dLybDkcIwq3q739t1S3Pb9UqtrESip5dKgeHxNsWErc51J8Yzyi5dKcXtjowzGxlaZG9IIFRduNVgJu52dMvJ2NrbevrNeunez+FEwYAWMUTo/poe88ReZiGth/4RTJbbmIUfhTu0h0TJD52wpI5Xmp60mgSEfrJYrHZM7ttoNk3OaonrWPOErskXOpt4EUKpulpN2gkrZaCeo1o4KBeoY25NFZgFa3y69/0Gyb1BY+eoUKEGAHRuJW42/doo2EC3B29Iy7T/Yivs24hhi0iaRbfjs2y8tuI+iiLOrze445xSbbW3o6Ww7R0ZDII1NN8d+VcQxQ+2tVkBtOPbseWx2Gb6KsT13vSZ258oNa0Ia9+gUArEUAePWvTTDHp56JuQq3Ms49yqW6xX7+fqUY9uiLqREyqQxgppgVASW422EDfYOOqYjmcUhPjAK8PhuoJcE3pFD7mJPbwgsDVTofxed7t2ec6ETSK3u3BmLcv/kpdlWt0zNEoEdf8vUrH2yYG2AGYAEWcoMtSt2Jgu4YGCVkxehXj6P6PEhQzfHCyI77zMR/tkrcm0nv1j37kW4sdNGeum4aWCmYqS9X6ClLmfvN73cah2bHGCNMvRuhj0MZd27GeDZG64EKdEaMD/lXmdLnsU0B4uMSfVJD8+I7kKgnjR0hWxVlQPCiA1DPuWwxz6D3EjlqpyOXthV5zpuRlo+f1LxK9wVE80IeAiqceXH0znDdEgPN7Q3zSzx3tOPE1R/HGskz0ejxbDEatwjHdPzbFY+5MbuFVl9iH2v0V4xGyVJltJKKAxd5c3yePqwtQxhJ5MUQzDvZtgdNKR+/vw93kXP0+KdLTFs8OhPz5+zf8nMOh++49DxDMMogxP2A2eRguXrZ23ugKruhDLQPTwCX7uRWcc/oRfpbqrEGhU7RSW+zsH+bdgv4eIfeCt+fhrgxxmyeMYwKa7AvH7mL2KeXD/78dPAGoSyyw89/uMfyR/JvETschUGSgipgsAOCDEm3sJCZWTSAaa4YX941EUlXaMXYY/s4usOxYz4DbC1oEACm8JIFQncWsYLQOXYzJB06dIHNeCYoHY7qwzD3KqgRRQsfPYOlOm///4P+zRkH4qD7Bc6SBKSpVOpDbInY+ce+MCPCrv2rYwUvs9vEXlEGfhqeth7YkAhRJsm7vPU8tlrpBY8d4L+i94eSRqHffbuXU5R8WZDyxg7in7euCpTiM0/2zbrZIlvdnhAuL/P8qnUP9j/8eNEq3RFEknubIazcx8Pv15jSrG/lGyoouZZhVC7jTcOW2dOx8uDjbnO5kVx4jQIIDUP0l5VMjomrDfvaIaSD4/WbhKluJ1d4KdFKa2ybFq0a/ceOuAqc8Mpx5RyGGW1esa8thkz/2J/eWrTQz0bFkqhT5Kr9cj9vcvHm82W3m3tPbHN2LnKSRGI+n+GMuiG +sidebar_class_name: "patch api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Updates an outgoing webhook associated with the given app version. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-presets.ParamsDetails.json b/docs/release-management-api/apps/api-reference/update-presets.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-presets.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-presets.RequestSchema.json b/docs/release-management-api/apps/api-reference/update-presets.RequestSchema.json new file mode 100644 index 00000000..148eeb9a --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-presets.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"default":{"type":"boolean","description":"If set to true, this preset will be used as the default template for the app."},"release_candidate":{"type":"object","properties":{"source":{"type":"string","enum":["ci","api"]},"branch":{"type":"string"},"workflow":{"type":"string"},"auto_select":{"type":"boolean"}}},"auto_upload":{"type":"boolean","description":"If set to true, Release Management will upload all successful builds that ran on the given branch with the given workflow to the App Store."},"notifications":{"type":"object","properties":{"slack_webhook_url":{"type":"string","deprecated":true,"description":"You can get notifications about release updates on Slack by setting this value. Make sure to send the properly formatted webhook url. Regex for validation: ^https:\\/\\/.*\\.slack\\.com\\/services\\/T[a-zA-Z0-9]*\\/B[a-zA-Z0-9]*\\/[a-zA-Z0-9]*$"},"slack_notification_integration_id":{"type":"string","description":"You can get notifications about release updates on Slack by setting this value. Make sure to send the an integration ID found in Workspace Settings."},"teams_webhook_url":{"type":"string","description":"You can get notifications about release updates on Teams by setting this value. Make sure to send the properly formatted webhook url. Regex for validation: ^https:\\/\\/(?:.*\\.webhook|outlook)\\.office(?:365)?\\.com\\/webhookb2\\/.*"}}},"approvals":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"summary":{"type":"string"}}},"description":"Tasks for the approval stage. Sending this value will replace the possibly already existing approval task list."},"automation":{"type":"array","items":{"type":"object","properties":{"event_name":{"enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed"],"type":"string"},"workflow_name":{"type":"string"},"pipeline_name":{"type":"string"}}},"description":"Automation events (workflow or pipeline runs) setup for specific event types. Sending this value will replace the possibly already existing automation list."},"outgoing_webhooks":{"type":"array","items":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed","app_store_release_cancelled","app_store_release_completed","app_store_release_started","app_store_review_approved","app_store_review_cancelled","app_store_review_rejected","app_store_review_submitted","app_store_version_created","app_store_version_updated","app_version_added","approval_task_added","approval_task_changed","approval_task_completed","approval_task_deleted","approval_task_reopened","approval_tasks_completed","auto-upload_disabled","auto-upload_enabled","automation_added","automation_removed","google_play_automated_rollout_cancelled","google_play_automated_rollout_configured","google_play_automated_rollout_paused","google_play_automated_rollout_resumed","google_play_release_completed","google_play_release_notes_localization_added","google_play_release_notes_localization_changed","google_play_release_notes_localization_removed","google_play_release_started","google_play_rollout_percentage_changed","google_play_testing_track_release_completed","google_play_testing_track_release_failed","google_play_upload_completed","google_play_upload_failed","google_play_upload_started","metadata_localization_added","metadata_localization_changed","metadata_localization_removed","microsoft_teams_connection_changed","outgoing_webhook_added","outgoing_webhook_deleted","outgoing_webhook_updated","phased_release_disabled","phased_release_enabled","phased_release_paused","phased_release_resumed","release_candidate_auto_select_latest_build_disabled","release_candidate_auto_select_latest_build_enabled","release_candidate_build_selected","release_candidate_source_changed","release_description_changed","release_settings_changed","slack_connection_changed","stopped_managing_release","testflight_app_review_approved","testflight_app_review_rejected","testflight_app_review_submitted","testflight_distribution_start_failed","testflight_distribution_started","testflight_distribution_stopped","testflight_processing_completed","testflight_processing_failed","testflight_upload_completed","testflight_upload_failed","testflight_upload_started","testflight_what_to_test_added","testflight_what_to_test_changed","testflight_what_to_test_deleted"]},"description":"A list of event names that will trigger this webhook. These events correspond to specific actions or states in the release process."},"all_events":{"type":"boolean","description":"Indicates whether this webhook should be triggered for all events. Set to true to enable the webhook for every event."},"webhook_configuration_id":{"type":"string","description":"The unique identifier of the webhook, that can be found in the workspace integration settings. This ID links the webhook to the workspace."}}},"description":"COMING SOON. A collection of outgoing webhooks configured to trigger for specific event types. Each webhook can be associated with one or more events or set to trigger for all events."}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-presets.StatusCodes.json b/docs/release-management-api/apps/api-reference/update-presets.StatusCodes.json new file mode 100644 index 00000000..cbf5e4a1 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-presets.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Presets","content":{"application/json":{"examples":{"200 - Presets":{"value":{"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","id":"ed81ff4b-e4d8-4f29-a442-386706a41a93","template_name":"","default":false,"description":"","auto_upload":false,"approvals":[{"summary":"qa-check","description":"Modified - After quality assurance has finished testing, check back here."},{"summary":"security-check","description":"Modified - Everything is adhering to our security policies."}],"notifications":{"teams_webhook_url":"https://outlook.office.com/webhookb2/modified","slack_notification_integration_id":"ceec9565-0de0-4603-92b2-255e42c2d203"},"automation":[{"event_name":"release_candidate_set","workflow_name":"modified-google-ser-cred-test"},{"event_name":"approvals_completed","pipeline_name":"modified-notify-stakeholders"}],"release_notes":[{"locale":"en-GB","whats_new":"What is new in english"},{"locale":"hu","whats_new":"What is new in hungarian"}],"default_release_method":"phased","app_store_release_type":"MANUAL","outgoing_webhooks":[{"all_events":true,"webhook_configuration_id":"738f9f7c-5ee6-4546-84d7-d91951a742c5"},{"events":["approvals_completed","release_candidate_set"],"all_events":false,"webhook_configuration_id":"ccdfc531-df50-4ed9-a610-ad7599cf27a2"}],"release_candidate":{"branch":"modified-main","workflow":"modified-build-app","source":"ci","auto_select":true}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"examples":{"400 - Bad request":{"value":{"code":"ERR_VALIDATION","message":"ProductPlatform::Service::Error::NotFound"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"409":{"description":"Conflict","content":{"application/json":{"examples":{"409 - Conflict":{"value":{"code":"ERR_DUPLICATED_AUTOMATION_PIPELINE_PAIR","message":"automation already exists: [{\"event_name\":\"release_candidate_set\",\"workflow_name\":\"workflow_1\"},{\"event_name\":\"release_candidate_set\",\"workflow_name\":\"workflow_1\"}]"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-presets.api.mdx b/docs/release-management-api/apps/api-reference/update-presets.api.mdx new file mode 100644 index 00000000..26d70753 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-presets.api.mdx @@ -0,0 +1,69 @@ +--- +id: update-presets +title: "Update the preset template" +description: "Updates the preset template for the app." +sidebar_label: "Update the preset template" +hide_title: true +hide_table_of_contents: true +api: eJztWuty27gVfhWMpp1sMqZkybIdaXY3o8Taraax4/qSnW7sciASlBhTBEOQdryu//YB+oh9kn4H4FWkfOlut3+aycgScHBw7jjnAHcdVygn9qPEl2Fn3DmPXJ4IxZKlYFEslEhYIlZRgEHmyViP8yjqdrY6MhIxp2Uzt1h4rJcozCrhpLGf3HbGn+46ibwSwP7p8v5yq5PwhcL3Tg6LoYjHfCUSESsNHuIHUPou8PhEVcSTJb7H4kvqxwLbJXEqsIezFCveGWOD24hWqCT2w0XnnrYB9kiGSiiaH2xv0586ryWxjgwTESYEAuYC39F89T4rgrvriK8cIigwMYvlSzFwzYNU0BcgCYWTCNcGDtsnoXg7ruNtj4bWcCS2raE3H1nzvfnQcpzBYH/kDeY7riAeCVa4r/ueN5xbYui+BuxgZPHhcGDtvN7b397jwz4f7QA214adCQlDrvB4GoB6jwdKbK1xCQCeJtJOo0BytwACjbEE7UbiKl2teAxldb5wC1J1rjrreA6l63u+cMH9xIOq2JeUB1Aw40qlMQ8dwZZcMc8PfbUEGKwogTK2mEbH5hwfSxGLbud+q7phbiiPbzu9FvFtsgRS5ivGXWCj74lkMo1ZjodFEgr0hcJGMINQJlhvFKr1lQi+UvaNmC+lvLLTOMAmyySJ1LjXk2kSYLQrPSwRXUeuehngfNBbZZSQcQfgxq6itn1Y0CLOvpM+HSGc0e7errXtku73tnes0WA+sAa7u2I4cAbuYHsHotDKWXHDLTQhrmGIuXJjEQiuhO3w0PXJv2xYHfa/kfGVF8ibHC4nzVpIuQiEpURsOXAUi5Sg5V1DW+jeBocw7EQzFfmRCPxQNJBqPm8tlfArsZSBS25qPMxQh3lhzCiQDg9orQitH98SoUueKDsUNxj7Cd9JcfjF/JCJcBHAUjR1xbpl+vCiZRoueOzzUBOQGb6dE4IQspQk+wiWqHkiT1SJjEUBk0WKw8nR+eQ9RbE0WUiYUW4RhhEeBLYWmcpjTW4w8HLPX6RVTe/vvPZG3r5j7QqxZw13h3vW66G7b7mj/mi3z/eh7d1SCTr2tWugXd1gtEpO5r8P0OM4rufs7vQt19uF5QkXkWSvv21xd393NHK8wT4f1BRY7Ef+MSdfXlb1v+IIwqXRVafmqR+4Frghp4AXOiRbx89jjsIGTmJEeG/+bXWGbbH4LXcZhXey12fF46GOx9Xl9ZjsEkXTkxP74+T97GByNvtwhA1WQim+EPoQkG7qJMeIqTjfVuPxqYiv4fzj8TSOZTweH8nkB5mGbqekv9+k/zwEw0sZ+79oTT6LgT4YqK3fwMH50eT87E8fTmY/Tw9qPNQWl2TutBx5Il75SuEHc0XoP5/WHTr8Gkg2EHw8PTmcnZ5C5PbB9Gi2RnUTTUn6qEn6Oxg6iHu2eYxAcbF2A6EH58fvZ+8mZ9MDGyL+cKjNxD6eHU/fz46m9vFkdlIjvYzZjAex4O4tE199lagx+3R3UQm2F53xRbtbX3S2LupxXMMWI/0LChm/Ha7LUrr9QVO6pwkQ8thlEJNA1sSKXOt54u4PIO7NyDbI//RscnQwOTmwoYXp0enUPpn+5Xx2smYwZ0scBHMRCs9PcpTIA5rb5YlqkZGZlDUXwG5bAJqBxzjkASP/R3ajvf95zO/qUNSOaAPjs6Oz6cmRPohKPk8lHWSU2txgZ3YTS53TZtRnYe6tdG+zrPMh+hopspx/FtqJcAAhgU98Q3uRQxaAcylhamEjIZt5TFcFkumDEYKGVrJS4cYPAmiIpYpkbqqIDPOGMuJ+wyn0MLX5UbOe+G8h8UhXdMCaMyjyO5fYIT/SGnVC9VBrmaydYQ3BaG3UUutny+7EsM4OeQjVr7S2SYQGIWJLwFTqOLAML4Vg6bAloSIlAkcM0YfkuPARIpjhEcuTZWU0Z09vidFJFMFdpMnCW3Ljh6Wus95a5txUgCtgC0BZVml1EfxVpgyaZgvIobY/43PkYiyzBojAFKJg8pT2ZfNbkl2iM34yOe1OXYjuSkBIsSAWlQjdrHQlwoNbMjYEagoBGd0MdHch+IX4qi0RaMjoQMGY/c3UARcXPfzvvrq46GqW8RdZGoaUSQ0Uvp594tYvE+vnbWt0CcDe27Xf1Z9/IFk/oWRoE+bvLzpsUCGMzQ4gJqQ/lH3/BGtSEUeld2rQKW1GLRXVf4GVM9rld7eCb96MtSFk6/6eVYgvMWSKRADs7O2+fFMYSVEwahvKokRZbBeS4XHMb6n4R2B8gvPV5NcSq4qCutkMuV+X/hlXV6oahzVxDAXeArI8hfjq8jVBKRaI39C9lqxE4jaHZGvpD60qsCXYBCeySrrrVe5/KoJqDXtXRPpNNTKVvkj6Fsski8923prApKmTbTB0m9WHTZi5SDjKxmtf3NiGq8ZwLD7r/KJSu0GqBA3kZe2ZtULsRSzTqAILv28SkgMnMdftkPZSUaXzlU8WrTc05GjMmi6H2jFBkBGmh6DcJAWOJQ8XNYIxEddZgMiRR5ExtICXRFArb9NxWmipAbHWZXiCtU7KZNvUwOyb4liDCecIWZyG6iVFhzTStq0i4VBgMasY7aN+tXWXtBSm3dJB+FUW/pT1jXzn/17wP/KCth5TdeOW2QfXloRU59bF35jbtOW6ghpzhQhrkyhcqDC3Hdj/pjlzNudz+Sh33XxMK8ymc2DDaCnXtfG6hCozrmgfjwXcKGxO1M2FvNfKTNz1FZ8HjWERVkeNq5fUl0OxWGWqqNpuBgB7jGUQIDDU9PIIZNbIewJoxFP1BDDUZOmqAddmhm3zuqtr686s/0tdDk8EL9X7xAXtQm16Rm02l0mbu1YBaxHlUSm0Q3vcb6oys5xNmPKQ+sDSkjMU/hxexdvl3j5bsts+X0p15TuxVNJLbJOyZ/2ROpL146zYvTFROmNjqowNphVfSLDidmszpeetTRTWvjZemnfz8KtU7jY1HVRi6+q5uv8zVpW0NRcZCLNqUxdftytajpFKotN2JmVFVmXKVJGtekNwjiKIZ0W9BNJFhqaeBFCobh4n7QCVY6MdoHp2VCAgY6Qn81QTqG27tP4HwR6B0PzVIcABdUeI3ar/tUO0EdHivC0p0+aFrXTTBZYNU9IWlLvPpvlSg5sgcj+7bKbGOgtl0styXMqpswaRTmohvcVCxCbZzXyzy86WAqV1lks7MjY35a4unfOcmTumHKc8OtEluG+6TXllnsnVFHeV66nHe2DwCkdjvFkKYKxTx9RSpoFLTcSMeBTtlM1TL8zsQTl80UOjv8Y7NXU5Floh6LrYrNFUbr4xe6xbAYGxNPS/YDvfBTq6+4pJ6pUtt4zYqakxF2XLREMUbZNqYyX3btIH+J8dQJfhlaqxkXXtCgTdtvro3YfD2dGP7PTDh6Mum0ChQWCCA1GYR+YcJSk8zzOMDI2FbC6YppzaihlBGXtcKen4XDdUqOEoUX4BwQrpYW5XhC9XU7lFRYtFO768tU11RURvPcadnmkpq96d795TeNPddHM7ay7t7+aww/OT9/e9zCatVdFG7V0PeghUqnfdx9prujKeZ136bFWt6V08AOCR3537oFiJri9bDcEQwggNA56y46pb7UZFl+X7l1M9ahzDvIIpi7vI/7PQ1R3hXqLSFHFjy+PJGUOwp8sBWDPEicOQTY5nUEUQ0NuV/E4/uwE0PRaSK10BnJSXBVNzU1Hj2zRoWxvw9dvc4lK48JDKbXAx1rzzXWuQm/0abeenPKcoNml7v1Fp2deetdRFWaCoPD7JFl7+Nu8wih3W31JU9ml/cFA+DXjSI4BH3yQUG96TeXlSm52f6EcWLbcOMCjyE1PDAeR60O03TPHVq/fYjYJJ3jqUiNRY+ubVK5Z3dD2fAl+in/qM2becLWPhffeizUdh/5YrHdXDEvG1u0xWwRvoU3Wj2Cf9HEF232XE/nGwXZKLH9gVnx/7+DgAihcM5/BCJN+9sOcBD69efP+xr72EYtq3Pf79RXgRnpUUFzdV5XUF9Zh/EPM4JT/r41QdbA/2a51liu+3YHPJrwVb+WSeWRAFYnqgQojnwpMaWIRd2vRBCRgkkK61SHGyaBG0sIJcS+8Bnv71j3+yjwN2mC9kP9JC4lA316RKgJ6UnRneA+/51vVbuUt8zjPALJgl4mvSAwBiGQjJLgFMLP/UiYqXdmNfNw6Xkh5qfOrcmSAeB/f3NIxgRW756bKM2caP86y99YlblfBvTrKr5pdsE2159A1v9dGgL2XpldyVuDWPDrXTZOGYdjcT78we1hktLxc2Ll3poY9ZMXEcESUPwl5Wjr/j8zOKtNm97spcEsdcN7T4jaFRRkXQ1GN3HZjIIjX3xgZldiu5rB80V/qgyb7oJ5ltUqgfIrlI6JO4al1yd2eOsfv7At5MbVxRHHSZwEkMoPrfzGBOTA== +sidebar_class_name: "put api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Updates the preset template for the app. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-what-to-test.ParamsDetails.json b/docs/release-management-api/apps/api-reference/update-what-to-test.ParamsDetails.json new file mode 100644 index 00000000..71c8f711 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-what-to-test.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier for the installable artifact.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-what-to-test.RequestSchema.json b/docs/release-management-api/apps/api-reference/update-what-to-test.RequestSchema.json new file mode 100644 index 00000000..347ab6dd --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-what-to-test.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"what_to_test":{"type":"string","description":"The what to test information for the installable artifact. This should be a string with a maximum length of 4000 characters. To remove the what to test, send an empty string."}},"required":["what_to_test"]}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-what-to-test.StatusCodes.json b/docs/release-management-api/apps/api-reference/update-what-to-test.StatusCodes.json new file mode 100644 index 00000000..f7c66f2c --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-what-to-test.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"What to test exists and sending empty what to test","content":{"application/json":{"examples":{"204 - Update what to test":{"value":{}},"204 - What to test exists and sending empty what to test":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/apps/api-reference/update-what-to-test.api.mdx b/docs/release-management-api/apps/api-reference/update-what-to-test.api.mdx new file mode 100644 index 00000000..ab448fe5 --- /dev/null +++ b/docs/release-management-api/apps/api-reference/update-what-to-test.api.mdx @@ -0,0 +1,69 @@ +--- +id: update-what-to-test +title: "Update what to test information" +description: "Update what to test information for an installable artifact." +sidebar_label: "Update what to test information" +hide_title: true +hide_table_of_contents: true +api: eJylVn9P40YQ/SorSxUtyi9yVJWi4070Lu1FBQ6FwKnlENrYk3gP2+vbXQfSKP/2A/Qj9pP0zdqGhAQqrvxhNvbOzJs3M293EURkQ6Nyp3QW9ILzPJKOxG0snXBaOLJOqGyiTSp5h8BKyAyvrJNJIscJCWmcmsjQtYJGoHMyfuMgunf2Cb5GegRP2GApLIxy86B3uQicviEEvbxaXjUCJ6cW62Cw4vqwcm0DbMilkSk5MtYbZ/iBGCqCV8XQc+lirNfzGcUkikJFF/tCRZTBnSLjs3D48lQahr4WyhBycKYgoA5jSmXQA+R5zlGtMyqbBksGbsjmOrNk+Xu3s8//1kF8WmWT7pR1FiRGwlIWwY2gNHfzNc6BIdSZA2D2JvM8UaHntf3FsstFQHcyzZP7oKIptpSOP85kUgDyYrlsVBu/Ac6aH/5rBPudvc1MzzNZuFgb9SdFL8sB7jiHVfuVoPAUMe/94fD6/OTwfPTh43DwR/89YqRkrZzS4+APMF9twjwlkypruaHRFOrlWF8B66aTJwCf9ofHg7OzwceT6/f9k8Ej1Jtuaug/djqb0AdAaTKZiDMyM7Ry3xhtXgYffgF/u6MnUhicjPrDk8OjNeRnGuMYc8fcIrK4NdqPRIWeZwit87OO5qWzZ/FtTJgef6GQ5yA3LCpOldi5K6+dvq67cn0et03/s1L2pAiIUayssLEukkiM8UGUIcStcjF+pfJOpUUqEsqmeKEnYr8DWsMYIhWyRsGDFoZSPSMfZRVGw48a62g5aqXrVlDTVkrP5XqyVyWtTLmOSrkLWe+87PWC9koazToN216oaNlmP02nm67WYC54qaKFSWC8GEtL58OjZdtQQlg3U5mhyCkq1p5126iYbc/2YDuTRnEIX4zKqmzSiSwSlCSIncttrw0b1RorZGappfTW0pRABLsR8FNyy2T5biAmhAW2PjPO/FsfuTo57uuPYL/RvD4JYpIRmY2Qp4cjkVHI/WvmXIsCcQ9PByIEbxbbqyOlVhHfJr4o3KXDh37ul8O02Y/35wIDmWgPUDneGQxLYsXxPbEcmhlFKUp8s25rbwP07u6R1jfceXW/anQkTN/u7orfdQHwaGWFdlJOxGSoJ15LERuaHOxsqyaYakY6tOiXiO5asUuTt2gC28qNSsHLCTg4qMB+1+08wMUPRMXzYg+P93CxI5w0U3IHO9fjRGY3O28u9jyfNqfwdVu++Zx9zkYPiFHfJOFhiig3BAGgSGAOf6GxKbgiexjQbqf7Uwsk3aAJCsOjg7GZI81YYpBSNTXejAcJjjO69Y7HBHL8nGUtDvosA6UTsNuc4mJAnoItqSj45hjI6Z+//hYXXXFcG4pf2ZAz5Ern2jq452JXDfQfl6jHNV4Rx/97/6rGwdGda+eJxDQAoJ/xRSUUl8FWoYBtz1+l1rQCwxdrbuzLYFFqhEmWS36NWTB8ibt6kASvJ5GyvIZATWRi6ZlMvx9WSveD+LZL2tZcaz3I5l6s/EkWYHkDdfCXxeUVdlUCwYDLD+9KWM0Rmz8YbpxUy0ZtcRiGlLtn916tqDW0590H7B5Xx2Fanq1G3vJ1E0+PUnuevML5d4sAzTgtyuO2dMpyxAK1Ln43Xvyqhb9ab+NhXdhqUvjJeW01WSxKaUXV6/3lpyct7sW3opyJAOp/AY+WSyI= +sidebar_class_name: "patch api-method" +info_path: en/release-management-api/apps/api-reference/release-management-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Update what to test information for an installable artifact. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/add-testers-to-tester-group.ParamsDetails.json b/docs/release-management-api/build-distributions/api-reference/add-testers-to-tester-group.ParamsDetails.json new file mode 100644 index 00000000..fa360ba3 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/add-testers-to-tester-group.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the tester group.","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"enum":["internal","external"],"type":"string"},"description":"Tester type. Defaults to internal."}]} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/add-testers-to-tester-group.RequestSchema.json b/docs/release-management-api/build-distributions/api-reference/add-testers-to-tester-group.RequestSchema.json new file mode 100644 index 00000000..3afdcba5 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/add-testers-to-tester-group.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_slugs":{"description":"User slugs to add as internal testers. Required for internal tester groups; ignored for external groups.","type":"array","items":{"type":"string","example":"user-slug-1"}},"emails":{"description":"Email addresses to add as external testers. Required for external tester groups (at most 1000); ignored for internal groups.","type":"array","items":{"type":"string","example":"tester@example.com"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/add-testers-to-tester-group.StatusCodes.json b/docs/release-management-api/build-distributions/api-reference/add-testers-to-tester-group.StatusCodes.json new file mode 100644 index 00000000..d23b620c --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/add-testers-to-tester-group.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Add external testers","content":{"application/json":{"examples":{"200 - Add tester(s)":{"value":{"errors":{}}},"200 - Add testers for the valid slugs only":{"value":{"errors":{"invalid-slug":"User not found."}}},"200 - Add external testers":{"value":{"errors":{}}}}}}},"400":{"description":"Tester type mismatch","content":{"application/json":{"examples":{"400 - Parameter missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: user_slugs"}},"400 - Invalid external emails":{"value":{"code":"ERR_VALIDATION","message":"Some of the provided emails are invalid.","details":{"invalid_emails":["nope"]}}},"400 - Invalid type value":{"value":{"code":"ERR_VALIDATION","message":"Invalid type: `not-a-valid-type`. Valid values are: internal, external."}},"400 - Tester type mismatch":{"value":{"code":"ERR_VALIDATION","message":"The resource is of type `internal` and cannot be accessed with type `external`."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to add testers to the tester group. Only Admins, Owners and Workspace Admins can add new testers to the tester groups."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/add-testers-to-tester-group.api.mdx b/docs/release-management-api/build-distributions/api-reference/add-testers-to-tester-group.api.mdx new file mode 100644 index 00000000..c163aeeb --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/add-testers-to-tester-group.api.mdx @@ -0,0 +1,69 @@ +--- +id: add-testers-to-tester-group +title: "Add testers to a tester group" +description: "Adds testers to a tester group for the app. For internal groups provide `user_slugs` (Bitrise users); for external groups (`type=external`) provide an `emails` array (at most 1000) and a tester is created/reused for each address. The array that does not match the group type is ignored." +sidebar_label: "Add testers to a tester group" +hide_title: true +hide_table_of_contents: true +api: eJztWN1yGjcUfhXNznT8M2YxTjKdIXFSUhOXqY09GLvTOh4jdgUo3l1tJC0OZbjtA/QR+yQ9R9KyLAtu6XVvMEg6R9/5+86R517IVCB5qrlIvKbXCkNFNFOaSfgrCHU/yFiKLCUjIYmeMELT1Cef4AdPYDOhkd1XJJViykNGBpli8lFF2VgNyP5HriVXjOCiOnhr1LBvZcn9gZ6l7DRfHhwsddGEDFhMeQSqqJR0RvapJrFQmjSOj48P4EBYAOWKBJJRzcK6ZHBhaG+jwYTQMJRMKZ/00QSjSU9AVSiYIokAnVTDMTTQmouIUCEfJ0Ky0PeOPJEySdFZndC6q2+d1Rf2yzkKwjnFgkxyPfOa93NPiycG3r1/WDwceZqOFXz37HliBJQHGymVNGaozAgl8AOu4CFo4xiblOoJfC8HDE3JMh7evSbgq0TzEQelYmSsWI0dgpfsa8bBEK+pZcYAZDABx3pNQAiWgjYFcUrG3mJxtLzf7DgEXzMmZyU9IxqpkiKWZDFalycGnM5Dijau3VOxxgLGUz45YyOaRdrkYa7O99CFEMVUJIopvPHk+Bj/VPK4yDCXzwAlEKAn0XgeUjjigQll/YtCIQD/jcZptFRLagT1WPF9dYDLUxplzJyVUmCk5gvwVuW0WpYKCPCQmEogIolmm5WAv8zBGh4E/LdQKSYlRyJLIPHWLqmYtg3Zwgi+3uSiFV+TmCuT+7u56LXBc52nLWpRGNZVMIEIMeDtXu/xutVrXbb77d7jZefmptM9h9tiqEc6Zia7QQ0Wm9NCCv9lpghZnOoZMZxjXNUkBcd4zkqA07G7hYssdWwDdde66Jy1+p2rbgnNjYhZXkWOh0KnCZiD5Rh8U486v8CtPuZX3nsJ8IX3sKjCM25fAtoB2aqCJhlAjtRozeYOLg18cmf2jUoDtrmsnqOlV/wVj21MhN1AIQtBUYpMBiZW6DlUN8hvHhiSDmiCOT0E9g0CEAafPnM9cWeX1G/S3fmsUU3c24RmeiIk/52FuyZsA+wtyW+x87bbuu3/dNXr/NY+K1laEi5gvqrCvGbSpLJICBAz3x3rKyyuipJtxdXumaq66j6etbudNdS/ioxM6JQBpZB0qdJ2+BXOgp+VtkGugLSAdGKeqCNy9ZzgQQzmL0I+qZRCwO0mRtdoS9jzSxpVEd43m3ipk48UN0xOQaiNdLab7964UtukaIv/Ol0gpm7rosICeoJk9Aw3k2cpTHN06LELgl0fRTizyl7EV+m1YviFBRruA36BmGhusa+QWjXzsSvYVuIiR1Uxgjmf+6Tn2rPpQWvbLgZv85lm0yyGrOZAmikJ279msaoOCke522EJgZv2VWsYcil4t2xEG9fzWYytWrLe1dYsWdteDo6lYbBs2Np4+t8Ms9f94Bb8QMRFDmB+CJwEU0CAscQZrenVrUzNXluf83BRByNrxSSiTE7aSS+TEcjMh1Sx297FAubWiMH3WkwTyMMYkqo+PakPMx6FtZAjwmGGzlT1aQNUTankdOhS3ymxbjfzE6ieaJ2qZr1OU+4P7Szuc7FxlrS4CKohoMfxM25g/jJTuw/FeHtjVq0D7ZC79CRc9jOb5aPjhNGQycqV160+8AX2AipnmAqQRaR13QEyiSL0k5tCc9I1NWXSC+uqV1RgOw9XuYLuS2n5UGTl/aawPiwQ7UgYK7g20e/ZYJDLZTAMvhr5iPEgZ6vxwGBAUK1p0xO/UbH38PBCiCdklHw+FKAEFH44PCTI0kiiIw70yjWZMGze7yiZSDY63duUF+DkWigCVQcR9s2f6Dj6AOmk/FTyGFzaBfedOhO+OzkujIAfcCt83jXg4wxU7BFN5Zjp073HYUSTp733dw1jqkpZ8K5O339OPif9AjGkRhRhLw9ZKlmALy4YcMknNpQZBrMBJXlyfPK9D657gvzJYGwyz61Z3oxiPpZGzHUJbByoeMjAOXiYJT5e+qIHrBLwbm0MzyBmXLDBFI5NCe4Am/76409yd0Iuc0FyjoJoIT5IsJBBPaaAy71WuUOWn8TrEV7pA/8/pv/pMe2YQgPOehpRIAoIgGHDuWPSvEwdk4JM0zyIV8kUqnqC7AuH55ZEZbRY4LJ9ryLFAm0iRRYv1q1B+xdP0C3An4Dtlu9lN2N45r2aM/SOUPbz9ndAdnrmb0SXs3IyW0WXowanLpD9HE0jTrvxo0VT65fNqkw4+B8DK9GC0T7VL559WGmc11c3fTg8dFNUbEcySZ/x/wzwaUCK1PIrHDBrcw/KepzZKc3qxJ6AXaLcgZ5MB3JfzL9iNrmh3F1yn+AnmrVRZD63/Q0SLT9vt7ZKLDug8zj6AVD/Da4pwQ0= +sidebar_class_name: "post api-method" +info_path: en/release-management-api/build-distributions/api-reference/release-management-api-build-distributions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Adds testers to a tester group for the app. For internal groups provide `user_slugs` (Bitrise users); for external groups (`type=external`) provide an `emails` array (at most 1000) and a tester is created/reused for each address. The array that does not match the group type is ignored. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/create-tester-group.ParamsDetails.json b/docs/release-management-api/build-distributions/api-reference/create-tester-group.ParamsDetails.json new file mode 100644 index 00000000..e36f1231 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/create-tester-group.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"type","in":"query","required":false,"schema":{"enum":["internal","external"],"type":"string"},"description":"Tester type. Defaults to internal."}]} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/create-tester-group.RequestSchema.json b/docs/release-management-api/build-distributions/api-reference/create-tester-group.RequestSchema.json new file mode 100644 index 00000000..ac65135b --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/create-tester-group.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"app_id":{"description":"An uuidV4 identifier for your app.","type":"string"},"name":{"description":"The name of the new tester group. Should be unique in the scope of the app.","type":"string","example":"My favorite tester group"},"auto_notify":{"description":"If set to true it indicates the tester group will receive notifications automatically.","type":"boolean"},"emails":{"description":"Email addresses added as external testers to the group. Required for external tester groups (at least one, at most 1000, each at most 255 characters). Ignored for internal tester groups.","type":"array","maxItems":1000,"items":{"type":"string","maxLength":255,"example":"tester@example.com"}}},"required":["app_id","name"]}}}}} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/create-tester-group.StatusCodes.json b/docs/release-management-api/build-distributions/api-reference/create-tester-group.StatusCodes.json new file mode 100644 index 00000000..55d1b51a --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/create-tester-group.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"External tester group","content":{"application/json":{"examples":{"201 - The created tester group":{"value":{"id":"5eb36231-b162-4c16-8c2c-02a0ab1bb05f","name":"My favorite tester group","type":"internal","auto_notify":true,"notification_types":{"email":{"enabled":true}},"tester_count":0,"enabled_notification_types":["email"]}},"201 - External tester group":{"value":{"id":"7f3c1b2a-9d4e-4c6a-8b1f-2e5d6c7a8b9c","name":"My external testers","type":"external","auto_notify":false,"notification_types":{"email":{"enabled":true}},"tester_count":2,"enabled_notification_types":["email"]}}}}}},"400":{"description":"Invalid type value","content":{"application/json":{"examples":{"400 - Parameter missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: name"}},"400 - External group without emails":{"value":{"code":"ERR_VALIDATION","message":"At least one email is required for an external tester group."}},"400 - External group with invalid emails":{"value":{"code":"ERR_VALIDATION","message":"Some of the provided emails are invalid.","details":{"invalid_emails":["nope"]}}},"400 - Invalid type value":{"value":{"code":"ERR_VALIDATION","message":"Invalid type: `not-a-valid-type`. Valid values are: internal, external."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to create tester group. Only Admins, Owners and Workspace Admins can create new tester groups."}}}}}},"422":{"description":"Tester group name has already taken.","content":{"application/json":{"examples":{"422 - Tester group name has already taken.":{"value":{"code":"ERR_UNPROCESSABLE_ENTITY","message":"Validation failed: Name has already been taken"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/create-tester-group.api.mdx b/docs/release-management-api/build-distributions/api-reference/create-tester-group.api.mdx new file mode 100644 index 00000000..129e3fab --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/create-tester-group.api.mdx @@ -0,0 +1,69 @@ +--- +id: create-tester-group +title: "Create a tester group" +description: "Creates a tester group for the app. Without a `type` (or with `type=internal`) an internal group of Bitrise users is created. With `type=external` an external group of email-only testers is created: provide a non-empty `emails` array (at most 1000 addresses, each at most 255 characters, syntactically validated) and a tester is created for every address and added to the group. The `emails` field is ignored for internal groups. For example, create an external group with `?type=external` and body `{ 'app_id': '', 'name': 'My external testers', 'emails': ['tester1@example.com', 'tester2@example.com'] }`." +sidebar_label: "Create a tester group" +hide_title: true +hide_table_of_contents: true +api: eJztWN1y4jgWfhWVq7Z6pgsbcJp0D9U/S3eYXmoTkgI6U7MJRWRbgCa25ZZl0gzF7TzAPuI+yZ4jyZi/ZDu7F3szuSBgS9855ztH50crJ2J5KHmmuEidtvNJMqpYTiiBT8UkmUlRZGQqJFFzRmiWeeQXruaiULDmTi0zdkd+gLcP8ND8fsdT2JjS+O5HQlNS/rJIYko+ciV5zkiRM5kTnpNQC40MsgVh3ywIYpQ/KgyWUB67Io2XVtFtoDbJpFjwCPQlqUhdlmRqSe70nhwApaRL8gNVJBG5Is1Go0FoFEmW5yyvEUbDOSlf+q0WCedU0hBl1Ei+TBV85yGNQfSCxjxCiWhpVJFWqaKZYwsml6UIszKK4J0SmlRtlEdG8HWj45SzOEIcPkuFtDi7VOYe+RnBv9Eki1nNSjxCl3HNhwNaIxKICHhZkVsHHDvh0a3Thu9vi4JH72+dGnxPacLM04tlhWspN0uMyrjo5tYxb5p/tVp5oUjMKvPC330xJus7z6k5ImOSYgT2ok0MjvSGz2gBrMhZWEiulk77ZuUocc8gWG/G63HNUXSWw3fHrCd6Q+7Aiwy8ljDUU29CSwAcWQA8jsH+tQC/wA/JvhYcSHbaUxrnDKSFc7DKaa8clhYJopfUw+qSBZSh0dpODgGdzpx1be80WZ1wlUfO2JQWscrR7SWc56AJEBaZSCH4UKLfaOK/XaDuLvPGsaBLKAAoVbgBPBhDWOKG+m857gLtDdklLnF1kJWhuYMFKyCaC4ZfOHqhxYKTU/+k6QbNU999FTZP3TehH7oNnzZo0AyCRmsKGlhaITqmdCHARWxfR8vRFoO0UGKSCsWn4E8lC2Bc/7LqT3CH1lmHlnEDDWJ0EK5eA89GxiQUBVrfqJUrJseAbizQGHcaHo4TekDC6+lJ2Ax86v4UvWJAwil13wTNqeuzVnQavqZvgp/CHRL2j0hl/yZs9uy3Ife/EeB/NwH4V3NeNRqHQdZLdT7T4UoMD8+KMAAFZq/KY0cSnud4LLZZDUWEZHQHg8lVZ9C56I66g8lFbzjs9T+DtAQSJJ3hCn16MQFaFGIrkEbC5yap66yo1W4T7QVr3baLqyyIVcukq8eUuu6c9846o95lf0ebjiIxo1APRMoMAqpQ5g2dnLfz7nZQeU+rVKr/3+k1FAnDcojM2JpXIkGZYyU45tiIqVKAfTopRd5A9EGMjteVpkdi4XmabQO0yR1EpUtd/cjVTYNHrvV7DamVbW+yYm3DJJJXRuyRtPglhaM0h6zzOxyNZ8YqZoGd/Y/Y96Xf+TL62+Wg94/u2Y6FO5srNU8O1bxiUkexSEnEUv58XU/wXB2APHauugN9oC77k7Nuv7en9a+iIHO6YNAYkWwDqYuSbSB2gpdcYovViRKeQvdz+ZBip4Wtwy9C3ucZDZl9SUI4ABYhZQ87KPmWG33/kJ/RdquJpxg0BCkxoEF/oihUe++ZlPk+FrvvwX3U7VeDy0/d4bDz8bw76fZHvdGvO0Rem94P/TGFY4RdZ39fRMBYauRsCGgdz7w2LwyZhF6RdKUU8nkWt+yxPQb0iIm9PiTffuf8IKOoOSbcB5BMHqTAxqbUHjMekPoR+kYD9qR+VRtla6AIfmOhAnmQqyD4FDe6m+bzkJZOSrAVvX5FIK+lWNbAJMy1S1FIPYs4R1owU4wPYgwypA4Bmy33Y9QjQygP0HMHMJik/CsWmVSvzEPQtdx2VGit9MRTjdB6r+4fxMCU5EzpmUCicAXyI2QUsiNK3pnHHngcQ/kJGdcnuar4EHsgJKF2QtnSNRACSliKelSlZq/L1IVtMwrZKQXieb+r2ZtcBtt18GgRzPW4tSmhNbI9fD05cv3okd6xEWgvv2zM1MMdRjT91lMsASu1CIebH6sD18HCc5bO1By6qFZr25VGxPbE4mwOgRkXbsrQtVE3NqcET5DA9jEDezDaKaI7dQPoGp31UIOH1IwnhYQ+z1kFNGdfBufrumTIFnMTmsLBTCD86wu/HhQ8jtyIo/ZBoR1eXzQBakElx/5Pm2hBjIP10AHQc6WyvF2v04x7gZnAPS6cg5EFI94kD4QhgGP6FHMU4EAznc3H1Uw21E8NuWYy27AMwv7OluW8NYekyOSByKvOCI5jiCkIxmQIrQLkdq56BEM4r9rrstzqQNddFSaaQZWSuqXrqpRS+fk/DypHxpKqQzoSDOM12jUV2l6udMwMjNvIxcZt2hKXfETPkbNtz6HbwP2GhIXvNQ+YefnyXIh7TMblBYwAEAD88PIlwUqORXcKeQLTxZxhD/WWkrlk03cvjkUQuMONRJjXYQv75s1VEn+AwMu9TPIEyMcC9s6a8Be/URkBP0AqfF434eMMIF5AXZMzpt69mAQxTe9fvL9ualPzjIVv6/T9bXqbjiqNTcqC5BqxDBKXHkChdP7MAlmg25t48hv+aw+ou4dIK6B7VXPICcuyYUn4TJq5VWwyOAIHDMjBxVDNUeiTDBgQYNedQWVhmoIjpnCsDiADbPrXH/8k1z65KDeSz7gRLcRUiicc4DEEbIAdv0Hbd+1W7fzzzu3PO7f/w52bzdAKBNSzmHLdGegqtLIFq0x6ZcGClD/HggYvVqZQyXi9xsfmIg3LGJQme1Fh7zUejfrvuBt7RMl7qCibizzb2Dr6Iq2sgvpusFbWG9TL7PlkpLuj3b0Hveu6Vu7ohCHL1JNrx1sF/+pyOILFge2PE9NsS/qAt4zwCXribadJ/7BAP1s5kHVmhem/DebadIvz3VJ6r0up/aIvQu2rdLmt4U6ZLOnCTzTr6JbVyhRq8Ga53rx6dMemlJvV6Bhsfv4NZ7lr2A== +sidebar_class_name: "post api-method" +info_path: en/release-management-api/build-distributions/api-reference/release-management-api-build-distributions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Creates a tester group for the app. Without a `type` (or with `type=internal`) an internal group of Bitrise users is created. With `type=external` an external group of email-only testers is created: provide a non-empty `emails` array (at most 1000 addresses, each at most 255 characters, syntactically validated) and a tester is created for every address and added to the group. The `emails` field is ignored for internal groups. For example, create an external group with `?type=external` and body `{ "app_id": "", "name": "My external testers", "emails": ["tester1@example.com", "tester2@example.com"] }`. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/delete-tester-group.ParamsDetails.json b/docs/release-management-api/build-distributions/api-reference/delete-tester-group.ParamsDetails.json new file mode 100644 index 00000000..fa360ba3 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/delete-tester-group.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the tester group.","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"enum":["internal","external"],"type":"string"},"description":"Tester type. Defaults to internal."}]} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/delete-tester-group.RequestSchema.json b/docs/release-management-api/build-distributions/api-reference/delete-tester-group.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/delete-tester-group.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/delete-tester-group.StatusCodes.json b/docs/release-management-api/build-distributions/api-reference/delete-tester-group.StatusCodes.json new file mode 100644 index 00000000..a650d00c --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/delete-tester-group.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Delete tester group","content":{"application/json":{"examples":{"204 - Delete tester group":{"value":{}}}}}},"400":{"description":"Tester type mismatch","content":{"application/json":{"examples":{"400 - Invalid type value":{"value":{"code":"ERR_VALIDATION","message":"Invalid type: `not-a-valid-type`. Valid values are: internal, external."}},"400 - Tester type mismatch":{"value":{"code":"ERR_VALIDATION","message":"The resource is of type `internal` and cannot be accessed with type `external`."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to destroy the tester group. Only Admins, Owners and Workspace Admins can destroy tester groups."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/delete-tester-group.api.mdx b/docs/release-management-api/build-distributions/api-reference/delete-tester-group.api.mdx new file mode 100644 index 00000000..94a65544 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/delete-tester-group.api.mdx @@ -0,0 +1,69 @@ +--- +id: delete-tester-group +title: "Delete a tester group" +description: "Deletes a tester group. For external tester groups, any external tester that is left without membership in any group is also removed; internal testers are always kept. The `type` query parameter must match the group's type." +sidebar_label: "Delete a tester group" +hide_title: true +hide_table_of_contents: true +api: eJzlV9tuGzcQ/RVigcKtoYvlJCig5gIVUlKhjm3Isos2MWJKO9Ky2l1uSK4cVdBrP6Cf2C/pGe5FViQX9XPzsFktOWfOnCEP6XUQkp0alTml06Ab9CkmR1ZIgacjI+ZG51lLvNVG0Bd8SGW8M2QbQqarvTEXSSeUFTHNnLhXLtK5EwklEzI2UplQqQ/zEDxPxlYLQ4leUvgDRnfQMGwIU+7lyooFZa4lxhGJO7fK6E58zsmsRCaNTIhTJ7lFKummEVhQkeLICp7cChqBzshIrnYY1vWOfZp3PBMzLE1zo9wq6H5YB04vCMJ8uN3cNgIn5xbvQTFf+AAbYKDObn1Qih8AVyHQFMuaSRfhfVdrriHPVXjzXKiQUqdmCqB65mnvyI9QQ59zZQicnckJJKcRJTLogiEKA5p1RqXzYLNp1Pn9SMnAq7SDM4PmO0CU5glXV6mP2VVbucav8uxVUzaeZRZ9msk8dlBd181sBSyhIZvp1JLljKcnz/m/Q0twRwAwmWrApI6nyyyL1dT3sP275Rhw/yKTLK5RRVMcgsHgUsY5ylhv/L9G8PzkZJ/Cg1pEoqxfTE/jAFhwGKZIp8ICqMpcUwBeyIoORqNPN72zYb83Hl6cI09C1so5Dz0E6Iq7VLumbPpPTb/4W+LGj3tIv026td6NelO2grJSUDpY2tNI8bpFG3VupsR7l1csw91Vme+wt0MxlSn4igl27nSKYAq9EZRzK253TK5qRWe/FdepzOEeRv1B4VNb0EG9O/GP1Hl93rse/3QxGv426O9UuhO8pflsn+YlGahp8UNgK6unc30GrvsgjxC+HIzeD6+u0JhP/cH58CvWv+pcRHJJItUiqyH9XgRpZ/Rq32HERRqvRC9MVApHv7hPveuii79os7CZRKeLQW7rFubhQbBt5ItDe2pYefoVmSWCBsZo8zSVXpSb6hDQI0oNz8eD0XnvbEegKw2vjuBi4h6Zxb3R3jhL9jym+WwIvYMEjcK9u0G7KLdZlNteq3DjTwtmUfh+bmLMW0+kpevR2aZtgID3ZiJTZE6QrL08bU9yFYfNULGTTnKu1raXHUAtpVFyUhZbghRCejcFdORcZrvttsxUa6IQb6ml9MGTpeAlGEYAp9x7PMCGT75bt9vD7sp/9ZnLI68+WZDsZ1pVB0lEMiSzl/KyNxYp8T6XOI2x1HLk7V0OsV7i2GJ6eSZVG8p32fuSSmfaZ1Mu5hmjQjTxvhbN4zTFj6yb6D/UjUWD+AWF5Wmrs8fr+PhM6wX3eqaNr18DBIBvjo8F7xRezzOFla6ciIgN9KUUkaHZq6ND/YMYzVBPbRsh9KUVuSR+g7bbVmZUgtLPUearsoRvTk+2ReAHsuJ508GjD4gj4aSZk3t19GkSy3Rx9Pqm40u1GU1ftuXrj+nHdLxljBbGMftpSJkh7BM4KqziLU1MzqJ3cO85PTn9vgXpFuhzjkuTv4etKkNI1Nz4MPSHpUjp3gNPCOLwZEpbnPRfFShAoG5zjssLeQkOlKKAzTlQ099//iVuTsX7KlC840CukK8RmbYO8LwEyjVy+BL6dWvXW+v4H1xby73owLidxRJbEdJ5v1mX/vQh2PEnxHRxAcUWjyAwD68LYzLxZsOfixsh2xasiG1neyd8VOf/cMl7hOoCDlLfSEunDvyNsHK9J1L5dlTeZL8TT7pIH2RXOV26esiuYg0ZN7eYVVof8ywGerjYZO5ByN4JxgXWB0p/cDYYDzCdTXDXYBfeYMsX/3fHIUa75lnR4yff+g+GrNeFfW829fxi6NGI2uDL4rkInBX/AOU86CU= +sidebar_class_name: "delete api-method" +info_path: en/release-management-api/build-distributions/api-reference/release-management-api-build-distributions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Deletes a tester group. For external tester groups, any external tester that is left without membership in any group is also removed; internal testers are always kept. The `type` query parameter must match the group's type. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/delete-tester.ParamsDetails.json b/docs/release-management-api/build-distributions/api-reference/delete-tester.ParamsDetails.json new file mode 100644 index 00000000..f53a7a41 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/delete-tester.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"app_id","in":"query","required":true,"description":"The uuidV4 identifier of the app the tester group is connected to.","schema":{"type":"string"}},{"name":"tester_slug","in":"path","description":"The slug of the tester.","required":true,"schema":{"type":"string"}},{"name":"tester_group_id","in":"query","required":false,"description":"The uuidV4 identifier of a tester group. In case it is given, the specified tester will only be deleted from this specific tester group.","schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"enum":["internal","external"],"type":"string"},"description":"Tester type. Defaults to internal."}]} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/delete-tester.RequestSchema.json b/docs/release-management-api/build-distributions/api-reference/delete-tester.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/delete-tester.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/delete-tester.StatusCodes.json b/docs/release-management-api/build-distributions/api-reference/delete-tester.StatusCodes.json new file mode 100644 index 00000000..fbc88ed6 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/delete-tester.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Delete the tester","content":{"application/json":{"examples":{"204 - Delete the tester from the connected app":{"value":{}},"204 - Delete tester from the tester group":{"value":{}},"204 - Delete an external tester by email":{"value":{}}}}}},"400":{"description":"Tester type mismatch","content":{"application/json":{"examples":{"400 - Invalid type value":{"value":{"code":"ERR_VALIDATION","message":"Invalid type: `not-a-valid-type`. Valid values are: internal, external."}},"400 - Tester type mismatch":{"value":{"code":"ERR_VALIDATION","message":"The resource is of type `internal` and cannot be accessed with type `external`."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/delete-tester.api.mdx b/docs/release-management-api/build-distributions/api-reference/delete-tester.api.mdx new file mode 100644 index 00000000..949699ad --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/delete-tester.api.mdx @@ -0,0 +1,69 @@ +--- +id: delete-tester +title: "Delete a tester" +description: "Deletes a tester. This means that the endpoint will delete the specified tester from all tester groups in Build Distribution. In case you only want to delete the tester from a specific tester group use the optional tester_group_id parameter." +sidebar_label: "Delete a tester" +hide_title: true +hide_table_of_contents: true +api: eJzlV+tu4kYUfpWRpSptxCWwWVVCexEVtEXNZleERGp3o2TAA57GzHhnxmQp4m8foI/YJ+l3xjYYcLKbtj8qNT8cbM855zvfuXoVhMJOjEyc1CroBD0RCycs4wxXJ0yDjSJp2VxwZZmLuMNFMKHCREvl2L2MYxZ6Gf/CJmIip1KEuTibGj1nHIfy+5nRaWKZVOy7VMYh60nrjBynZL7BBopNuBVsqVOmVbxk9xxGnC6b2FFcGJzs6Gepzc5q7xYvrN/4tzcyZAk3fC7Iv6AW6EQYTgcH4YaBkRfASysmqZFuGXTerwKn7wRYen+9vq4Fjs8sfgfZURvg0Uat9ccVbqCRJ2QTuiQx/DEVZokbIz6m0giYdCYVtb04jIA+TWV4dcpkKJQjUg3TU+8WFJapyHxGlCZaKTFxxL4mx+wkEnMedAB8mRAS4lrNgvW6tgGXM2PjdFYgTLiLgipAdKjAkKdHhSNPsFrE42Fupjy2X04O36Fkm0/SET0zuRCqVp2nPpF9yo1Fnm1hlmOO8r8yzb6YYnrzOQ+3ioRK55RXqC9hkLw4LT7lPyntdu0ccJMBpFMN1hNTnsbOUgkV6hoBJa8RNtHKCksW2yen9K+qE5RiDRxIMAe+6TByMJYTXzbNXy1JAPknPk/ijU5WZwdKCk5FKVmhiiQWPE7h2QrU7UnvSZZj8KggV6xgrhAaLxlolvGuHP3VgtOTk0MaSnyyubRz7ibR05iAWkAaKJhD5/GKCssbCNAXUlT7w+HNVfds0OuOBm/PYWcurOUzelVW0GG3Srs6r/tHdXp022BX/r1XiQZucKqIeW3DQyPIPQWkSteeBooqEamkUzMRVGLUHEjdbWH5FkEIUYQKeKm0+GQCYQT9XrooP1tguyVwRShah6G4VDx1kTbyNxE+NQQt+Lsj/4Cfl+fdy9GPb4eDX/q9HU93hLcwnx3CfCcM2LS4QSNR8ulYnwHroZIHAL/rD98MLi4QmJte/3ywh/pQTQH9eVWyD/KosQthFkiNvjH6iXX/PM/2KkUPuDA4H/WH592zHeQXGoM0Qotj94IWDaN9V83R0ztN0zpr1UEtG1qdoJnVuW2uSoNt7ec4AcnmcmpQ/8FqjNFwOTxbNw2U4Hd9zhWMz2GvuWg3x7Sg1MPSgmKbixZULbiRfJz7myvJuPTdFqoj5xLbaTZ5IhtjCXkrGlJXz9SMIFLDoCevC3pBA0H4krjeriEX/qm3nC8jm8kDYz+JZTFoIsFD37P3krM7Ymi7RLNZ0ligVan7boASjWOL48XOkie7D7TvGVJNtbcmXUwnhhlp7M2GNK+nXrHYkV4iP4OwaDdaB7iOj8+0vqNwT7XJdjcogcLXx8fsZ6yDaCFsKtFLMMsjQc3tBWeREdOXR1XxAxn1UE9sEyLiUyNy8/g1wm4biZFzuH4ON1/mLnzVPtk6gRtYxfWqhUsPKo6Y42Ym3Mujm3HM1d3Rq6uWd5WWghdN/uqD+qBGW8TZLuHXiMQIlAq6HervezE2KZHeso61T9rfNkDdHeKcGpFt1rT1RnxBzXhmeLbGeSqUuPeKxwLk+GmqGmT0UQYyJWC3PsOqJDwFFa5I6CYb8OnP3/9gV232phBkP5AgeUhrRqKtg3pKgTxH9r8V9oO62vaN/+V3RV6XDvOtmcQcZQkafe9Z5e3qfb4IU4F0yps4Kj4C33RilfUpE6/X9DhbIKmLoTNRF3pgSS6T//Uw3za/Yf/Kd0WlY3foPaVvnbzRBwEtwl8O9T+02j/i5eHny9919/Pb+uNAsk+LrfXr7Xj6Z0lS/a1XCaWYP2pZhrLHlU/r9TWO55OJ0GUnutgJE1eSPdgxyK3NyO/1z/qjPo7TjNqdf3d+/uU//Ad7FbTd2VbgpCsFr1Jktcqm63q9OZ+9elBiM3+z08TUNUb5X7gaC/E= +sidebar_class_name: "delete api-method" +info_path: en/release-management-api/build-distributions/api-reference/release-management-api-build-distributions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Deletes a tester. This means that the endpoint will delete the specified tester from all tester groups in Build Distribution. In case you only want to delete the tester from a specific tester group use the optional tester_group_id parameter. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/get-tester-group.ParamsDetails.json b/docs/release-management-api/build-distributions/api-reference/get-tester-group.ParamsDetails.json new file mode 100644 index 00000000..fa360ba3 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/get-tester-group.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the tester group.","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"enum":["internal","external"],"type":"string"},"description":"Tester type. Defaults to internal."}]} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/get-tester-group.RequestSchema.json b/docs/release-management-api/build-distributions/api-reference/get-tester-group.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/get-tester-group.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/get-tester-group.StatusCodes.json b/docs/release-management-api/build-distributions/api-reference/get-tester-group.StatusCodes.json new file mode 100644 index 00000000..625a786e --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/get-tester-group.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"External tester group","content":{"application/json":{"examples":{"200 - Tester group":{"value":{"id":"6506b9dd-6cce-49e2-83ce-5aadd918b0aa","name":"Tester Group Example","type":"internal","auto_notify":false,"notification_types":{"email":{"enabled":true}},"tester_count":0,"enabled_notification_types":["email"]}},"200 - External tester group":{"value":{"id":"cd3623be-c61b-4e4f-8eec-5ae267056d7f","name":"External Group Example","type":"external","auto_notify":false,"notification_types":{"email":{"enabled":true}},"tester_count":0,"enabled_notification_types":["email"]}}}}}},"400":{"description":"Tester type mismatch","content":{"application/json":{"examples":{"400 - Invalid type value":{"value":{"code":"ERR_VALIDATION","message":"Invalid type: `not-a-valid-type`. Valid values are: internal, external."}},"400 - Tester type mismatch":{"value":{"code":"ERR_VALIDATION","message":"The resource is of type `internal` and cannot be accessed with type `external`."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/get-tester-group.api.mdx b/docs/release-management-api/build-distributions/api-reference/get-tester-group.api.mdx new file mode 100644 index 00000000..529957a3 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/get-tester-group.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-tester-group +title: "Get Tester group details" +description: "Gives back the details of the selected tester group. The `type` query parameter must match the group's type (`internal` by default, or `external`); for example, use `?type=external` to fetch an external group. A non-matching type returns a validation error." +sidebar_label: "Get Tester group details" +hide_title: true +hide_table_of_contents: true +api: eJztV9tu20YQ/ZUFgcKJIepmW0nUOIEKq65QxzFk2UDrGPKSHIlbUVxmdylbFfTaD+gn9ks6s7xIiqSieupL8+BQ3J2ZM2d2zwwXTgDaVyIxQsZO27kUM9DM4/6EmRBYAIaLSDM5sj81ROAbCJgBbUCxsZJpUmUDXHoy8wSe2NcU1JwlXPEp0I5pqg2bcuOH1oE1ONKMNrNXTyLGPTGPnpg3x1gjnkamwqRiT/CSr7z+no3wBbzwaRJBhaUaY30k+/NyDzOSjYBi8JgVbwtwHRbL2LUQRDzOIiswqYo142zGIxFwSp6BUlJVnYojE1D2VS8gRsAMbLaX5A+XNfipEmbutB8WjpETQN4eHpePFcfwscZnJ9vPrIF2cKHkQ1ujGH+gZxGgN0GsJ9yE+LxZCmI1TUVwf8pEALERI4FO80psFABNFXxNhQIEbFQKCNIPYcqdNiLEhNGbNgrTd5bLShnfruQIbN02/Ix4pDccQZxOKbuiaLi74Jpy/CbOVjYZYNpVZRdZqTUVrnBXdYhCBTqRsQZNEZv1Ov236ahb1HedAsTiS3QUGzLgSRIJ35aw9psmK0SfHaDCL3PZYN0e3+JRSIEeBJW9dVZvee+CwG35Prin76Dpvj3BpzPOg+Bd461X5xyj5lSuV5x1s1BOyckaYzw1chhLLOa8pNj+zPEOycSCRNZFlPHOvaioLNbPyRIf+jKldOuVYsdwl6OH3NEjWWaJ72ZwiwE/OGk1Tzxw/VbDc0/hdOS+BfCRAWi23tTPWsGb0YqB0ukeDsqj8t9yQP8qzumug7V2QtlUaKsYh52rU0tvL7aikjkqKS0ffBlYvvr94X3nqnfRGfQ+X2OcKWjNx7S07qDNnjAjl7v2lWtFtsru7bp1iSKmcFdxxCql/lWdPNPVUd9M7TBQpEZ4OWWqfGAi6wjkbk3DeRwwn8eIl3nAON4brbFXPAsT5ntLxSZwRSka26W4i/GMhFKJ3yE4tAQNzHfDfk+ed9edu8FPn/u9X7sXG5luGK9gnmzDvAGFbGpqHijQ4nCsJ4h128kewDfd/qfe7S0WZnjRve59g3rbTQH9bNdh7+VVY7egZng0utT8DoN/lp/2XY72pNC7HnT7152rDeS3Eluj7c3PGJk9K2n7VI6e1iTJ0RiMU8k6ZdupZffftdKlawsRLG1nJghZj00VCoez8LiGu/7VsqZwdMFnHARiDDvFSLVZs+alIgrcQFDX8lJKVddmDXQ140qQoNhMcycZi7ZzoevQmES3azWeiKon0F5DVcidXTzDxcgNQz/5jaAFaq5gL8PjarC4tW9t5Hy8KLs4BvsZ5kXTDoEHoLZC3nQGLAa6fRxnMWyxNDN1bnp4OaNIryS7OOa2xFYtRDySNpowEe3oZ6SxTyVp1o/LfiDe2MU6b0Qakp9BmDWrjS1cx8dXUk6o0DTRUf4SnaDDj8fH7BeZkniwkUAVEYaFQLL2nrNQwej8aFf9kAw3kL6uoQm8VEMzjT5i2XU1UWKKqV9jmud5Ct8166sk8AdGxb/3DfxzgS6OmOEKT9j50dCLeDw5+nDfsKnqBPz3Nf7hS/wlHqwQYwmjiFQugEQBXhLUObx5P4KnUiK9gVNvs958U0XqJljnVOHIFnLD5phmyGckw2NlzbA+REUMz9axB0gObYa4SkH/kYHMCbLrjnFQBEvBjlQE+qYYmNNff/zJ7pvsU2HILsmQMqSRLZHaoHs6AvkZwelXb0xKxSfBt9VdrKTj/4+I1dhj0FMtiTjeV+TXitIiF7EHZ0PE0KaNcxfqQIhVoOVFpl4qWi7pdTaik7ahXuXjUD497a3Ev5i690CdoMyUnwi5ljt2RC+k8UAor/r5p8VrdtCXzU50hRzG83V0BWqkcfmIu3J9JJzZQgdnksSsmWz1OEqwbDmX3UE2roabEjyxEpw/2K/AXXA25bXARn/pG2ynyWKRCfxyWe7PlvZalC0gz5wywG7yN0i0d4E= +sidebar_class_name: "get api-method" +info_path: en/release-management-api/build-distributions/api-reference/release-management-api-build-distributions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gives back the details of the selected tester group. The `type` query parameter must match the group's type (`internal` by default, or `external`); for example, use `?type=external` to fetch an external group. A non-matching type returns a validation error. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/list-build-distributions.ParamsDetails.json b/docs/release-management-api/build-distributions/api-reference/list-build-distributions.ParamsDetails.json new file mode 100644 index 00000000..a7658f1e --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/list-build-distributions.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"app_id","in":"query","required":true,"description":"The uuidV4 identifier of the app the build distribution is connected to.","schema":{"type":"string"}},{"name":"items_per_page","in":"query","required":false,"schema":{"default":10,"maximum":50,"minimum":1,"type":"integer"},"description":"Specifies the maximum number of build distribution versions returned per request."},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer"},"description":"Specifies which page should be returned from the whole result set in a paginated scenario."}]} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/list-build-distributions.RequestSchema.json b/docs/release-management-api/build-distributions/api-reference/list-build-distributions.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/list-build-distributions.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/list-build-distributions.StatusCodes.json b/docs/release-management-api/build-distributions/api-reference/list-build-distributions.StatusCodes.json new file mode 100644 index 00000000..19f24ab5 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/list-build-distributions.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Build distributions","content":{"application/json":{"examples":{"200 - Build distributions":{"value":{"items":[{"name":"3.2"},{"name":"3.1"},{"name":"3.0"},{"name":"2.4"},{"name":"2.3"},{"name":"2.2"},{"name":"2.1"},{"name":"2.0"},{"name":"1.3"},{"name":"1.2"}],"count":13}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/list-build-distributions.api.mdx b/docs/release-management-api/build-distributions/api-reference/list-build-distributions.api.mdx new file mode 100644 index 00000000..0a6aed9a --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/list-build-distributions.api.mdx @@ -0,0 +1,69 @@ +--- +id: list-build-distributions +title: "Get the list of the build distribution versions" +description: "Gives back a list of build distributions versions." +sidebar_label: "Get the list of the build distribution versions" +hide_title: true +hide_table_of_contents: true +api: eJytV21v4kYQ/isrS1XaiJiXJKqELnfKKTRFl3ARkEhtLkKLPeAttte3u4ZQxNf+gP7E/pLOrA3YvERNmvvAee2dZ55ndnZmsnB80J4SiREydprOtZiCZkPuTRhnodCGyREbpiL0mY8rJYYp7dRsCkrTg+tUHJmA4vS67SPEDe77TBZXRQPcpsFLlTBzp/m4cIycADp8fFo+VRzDxxqfHWvGynb4OeGKR2DQozWNcYF+eJIMhI+4goh/T0HNcaHgeyoUIBGjUqhsyesHwNJU+A9nTPgQGzESoEiiwQ8IaP/flcuEZp6MY/AM+MxIEq29ACLuNFHKPCE+tD0eO8tlZU1RGIj0AKMzSPgYDlMd8VBDEdKHEU9D4zTrtYoT8WcRpZHTPKeFiLNFvbJyLGIDY1DOclttLwGPFGorK4dhcRoNM9F7hK6OlSkwqYpRLbJnxBS0cZ2CtjcrequGWSC8gJFbpgOZIvMhbGiOlIyszFkgQ3qv0RvTYJiIMZXRTMScTk97EHMl8Awp83BfgnJBE8dGrZZRLRL4vJv8qBSzwWD+0HZMm1B4Nv+rf2iyWTjwzKMkXKOyE7YPBj9OeZgCPdhUKab3qdsohvvUrZeXteKy4Z6Vl6flZaO8rJeXJah62bZOtk8kOCW59dOl/Vdxzmr13WDdxzw1gVTiT/BfFyWEwyiV7Ivh8aRPbFrd7uC+c3nf//Vrt/176wp9RKA1peKW8w3N012ad6AioSnRGVYB8Xqup8h1F+QA4btW97bd67W/dgZXrU57i/UuzIr6+b50bCNLFfOQ9UDhZWUtpaR6Hf1zm5D7gQ5IaHf6rW7n8qbEvCexKAdY89gMPbOZkrb85ezpm6R+MAbjUA03AS6qtg+QwyzZUxXi28WQa7jv3iyrCkLA55OIx+gkQtzqtFG1heqkdHmq0zpCTfEm82GuKwcpVRsnMCbRzWqVJ8IdCrTX4Arp7GsMGS9GMAxx2EyYwJYUW8XAJW1PmzbWs2+t57yZrVsBOvsC81V1DID7oHZc3l32GXYUCqeaY1NhKfq9vGszj4ch1ZhVn8uT2h4otRdEHUnrTZiQdnSzoLHbddAszqrobPfhvMaj4ZRKwTav4+MbKSd0rCOprH6JIAj46fiY/SZT5BezkYh9JgwLQEGTfeAsUDC6ONp3fhiME196uoom8OwGJgo/4bFrN1EiQukdlHmRS/ihUduIwAV6xd+HOv5cIcQRM1xhPl0cDYYhjydHHx/qVqrGLvGhyj9+i7/F/Q1jPMIwpDbhQ6LAs/Uf79kvMFQpBb2O802j1vjZxdBN8JxTBSiYGzZHmQGfYtMUY8Wzpm9DEcPMAg8Bg0ObIXbJ6YsRyEAwuidjnD3AhmCPFIHY5AM1/fPX3+yhwW5XhuyaDEkhdchEaoPwlAJ5jlyDyZr8amQ7MMcUp7bSqS82BeRtM2Ce+QaeTTUJOSY+ErW3e5Hf/UeHZrkAudPzIrvzKlwu6XU2QVBFQBd0ozczxEGeP3bzceMn9o5z3V4hE7zNhYkzL5GObZT/nfD7z2Mv0t2ZPv837XcfwV7kv8P6aVPw7V8OlVVppbzJbC49DxJTsNpphoSy7k3XrT7upQpbrt4TW73zB/vnSv4pnhexS5V5RZt+KcB7TRaLrDdg1q/2Z58OWqy7R36opAAb0b9flrTv +sidebar_class_name: "get api-method" +info_path: en/release-management-api/build-distributions/api-reference/release-management-api-build-distributions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gives back a list of build distributions versions. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/list-potential-testers.ParamsDetails.json b/docs/release-management-api/build-distributions/api-reference/list-potential-testers.ParamsDetails.json new file mode 100644 index 00000000..10eb6d1b --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/list-potential-testers.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the tester group.","required":true,"schema":{"type":"string"}},{"name":"items_per_page","in":"query","required":false,"schema":{"default":30,"minimum":1,"type":"integer"},"description":"Specifies the maximum number of potential testers that this route will return for a page."},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer"},"description":"Specifies which page should be returned from the whole result set in a paginated scenario."},{"name":"search","in":"query","required":false,"schema":{"type":"string"},"description":"Searches for potential testers based on email or username, using a case-insensitive starts with search."},{"name":"type","in":"query","required":false,"schema":{"enum":["internal","external"],"type":"string"},"description":"Tester type. Defaults to internal."}]} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/list-potential-testers.RequestSchema.json b/docs/release-management-api/build-distributions/api-reference/list-potential-testers.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/list-potential-testers.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/list-potential-testers.StatusCodes.json b/docs/release-management-api/build-distributions/api-reference/list-potential-testers.StatusCodes.json new file mode 100644 index 00000000..1b1c5b3e --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/list-potential-testers.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Potential Testers","content":{"application/json":{"examples":{"200 - Potential Testers":{"value":{"total_count":3,"items":[{"email":"default-user@example.com","slug":"default-user-slug","username":"default-user","already_member":false},{"email":"need-to-find-this@example.com","slug":"need-to-find-this-slug","username":"need-to-find-this","already_member":true},{"email":"user2@bitrise.io","slug":"user2-slug","username":"user2","already_member":false}]}},"200 - when items_per_page param is sent":{"value":{"total_count":3,"items":[{"email":"default-user@example.com","slug":"default-user-slug","username":"default-user","already_member":false}]}},"200 - when search param is sent":{"value":{"total_count":1,"items":[{"email":"need-to-find-this@example.com","slug":"need-to-find-this-slug","username":"need-to-find-this","already_member":true}]}}}}}},"400":{"description":"Tester type mismatch","content":{"application/json":{"examples":{"400 - Invalid type value":{"value":{"code":"ERR_VALIDATION","message":"Invalid type: `not-a-valid-type`. Valid values are: internal, external."}},"400 - Tester type mismatch":{"value":{"code":"ERR_VALIDATION","message":"The resource is of type `internal` and cannot be accessed with type `external`."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to list the potential testers. Only Admins, Owners and Workspace Admins can list the potential testers."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/list-potential-testers.api.mdx b/docs/release-management-api/build-distributions/api-reference/list-potential-testers.api.mdx new file mode 100644 index 00000000..b2ee940a --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/list-potential-testers.api.mdx @@ -0,0 +1,69 @@ +--- +id: list-potential-testers +title: "Get a list of potential tester candidates to the tester groups" +description: "Gives back a paginated list of tester candidates." +sidebar_label: "Get a list of potential tester candidates to the tester groups" +hide_title: true +hide_table_of_contents: true +api: eJzNWNtu4zYQ/RVCQJE28CV2dlHA2JuLpKnRbLJwnBRt1khoaWyxkUgtScVxDb/2A/qJ/ZLOUJJt2Uq6Tq95cGSRnDlnhnPz3AvA+FokVijpdbwTcQ+Gjbh/xzhL+ERIbiFgkTCWqTGzYCxo5nMZiABXTMOreSoBzel8L0AJp7j1g7IgreDRwO03uMmAn2phZ17neu5ZdQeo7Xq4GNY8yycGn71sLzvRKk2MhwsJ1zwGd54OSfyC8kWA0gRhTbgN8blMYBACS1MRXL1gIiAQY4FCCTou5PAnpIKQa/iUCg0I2+oUEKQfQsy9DiKcJaTMWC3kxFssaiv9FmJzg5Rv0DxQYPmUgp6VJI55ZEoiAxjzNLJe5/Cg5sVCijiNvU6rVugS0sIEtLfYpHSRgE80jOMQ8wc6yWQajzJmSWHtnB/t4xY/hGHI1AKbiihiGmyqJRsrnbkWGt4areeSaT2XyzQUfuhwMBOqNArYCHKMeOHGWsWO7jRUEb03qI0ZsEzI0s00PkiuhSqRMcC1H+5AZ8PdW6idPARNxts294gbRKIkQ2kiYrgnNaAJSw2fUCIi9nFPXUgD0giLQcaM5dqiGYQNWYa3RMEh+nwCIMkB187wqDnC3fCQPw5rf8YvDz3a1WBHmWvxFilWiENoQ9JvEoUUDGlsHxxkF2Fd0DLw2SryfSXpJW3mSRIJ3+WK5s+GTiDyBx4n0VImq7NtIbh0z6MUnKuU5dGNr1ISeVjL4tElCGd9BJHfzTo54V0uvuGrmLJQlE42dtTdu5pXuGxjGVd4pIEHs5sYKOJy45OrCoUSIKhbVR8Lif8x7Kq1bm2rUL21p0I/5ap19XS8/W4k0LkGGkKtNLqVCi3u/aPMhpjucldMQ5CsnPGYS8sMc4vJvfq/c80mgSy8Phd4qwr4f+FipEF/Ne9FVaitxSyLhYm5dRlvh2h74SzUk2gGEWSClhZZPvgqINDH/f7NVfe0d9Qd9M7PUE8MxlDJ6HjrAjrsVipb53X3qk6vbhvsyq07kYZxjbuKvFJjRZZqeDlThFRJbTdQ1AZgulKp9oFcTg0AibstNN8y7GGokUG8VHm47+NhTOMuIWd7C2y3BK5wRWvbFZeSpzZUWvwCwa4uaCHf0vlHeF6edS8H3533ez8dH5WYlg6vYB5WJGfQaE2DXxh2RmJ3rIeUnLeEPAL4w3H/fe/iAh1zc3R81ttA/aNKWcixDErFkqVIV3Ncr0mlf6vQNti5jGasG2DHYWrsfCqp+pIff1D6ziQcfZ0tkmOfErQ01Muq0Orld4RdgL7Hi3istdK7GetlHltVgh4xWO9scNw/656W7HShsAMOqYWYomY21cq1ozl6WlPUdE/AerWsIe54zYxl3bW5pjkXwaK5NEHdrrXkBCrLc6mmLDenTuayf7poaoiAOpaYSwQS49nmfbs5SkUU1ANBfcQoJfKmed9CUffYgvFRzj0XUmoTvdDaxHSaTZ6IRqlUbbfvGS7XVTGUk0ckLVC7A855w9VEceHemiyPu7li2c+hsu9hVrRRIaZYVzU2wqI7YBIo+rme0QXEXM26H3p4h6KI7JTn7SLMnNNdthJyrJw2YSPa0c+Mxt4vjebk1Nk3ZDd2tG43MhoaP4Nw3260tnDt758qdUeup66T+CsUggLf7u8zih+641REsECzECitvuIs1DB+vVflPzRGPVC+aeIReGiENo7eottNI9EiRupnSPN1TuGL9sGKBH5Brfh51cKPIxSxx7B5xTv3eu9mFHF5t/fmquWoGmzvXzX5m4/yoxysEGcDCGbZABINvmvcMYF8CyOdktFbGKjtg/bXDTTdHfo51ZDNMLMiTcRiot0x9A+ZQsLUCR4BGoc2g2yQ0ictkAlB69YnOCGCM0EFFYGySQdy+v3X39hVm70vDrITOkgMqYlOlLEonq5AfkdOAPtmvhyXNxPP2uBcEFkfSc3mHZivUs6zJvM8DCwWsmYScYwCRO1CfZ4ni2uvlCzwTMcN2Nv5AiMuRL50ZJ7lCR0tFvQ6G08oi2BmoCywGlAeZfPPzbSPsL7DPFAxvOeJ2HOj13Pg/+1j7JP4/yLqf2mMfZLCcjZ/JonPmFWf1J8P1ivtw1X52vESf9nPB/Kv2E4/O1WiK0qWnK2jW15c7O2GuCuvYYQzW+hi35rYtSNbnQkRXDYKJ8cDGjdSG5bL5J0rk/mD+4muCk65BBbY6JN8WHlkPs+KMKaKYn+29OiJZZnOmRMDrPh/AM0yK/M= +sidebar_class_name: "get api-method" +info_path: en/release-management-api/build-distributions/api-reference/release-management-api-build-distributions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gives back a paginated list of tester candidates. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/list-test-builds.ParamsDetails.json b/docs/release-management-api/build-distributions/api-reference/list-test-builds.ParamsDetails.json new file mode 100644 index 00000000..a34035f9 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/list-test-builds.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"app_id","in":"query","required":true,"description":"The uuidV4 identifier of the app the tester group is connected to.","schema":{"type":"string"}},{"name":"version","in":"query","required":true,"description":"The version of the build distribution.","schema":{"type":"string"}},{"name":"items_per_page","in":"query","required":false,"schema":{"default":10,"maximum":50,"minimum":1,"type":"integer"},"description":"Specifies the maximum number of test builds returned per request."},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer"},"description":"Specifies which page should be returned from the whole result set in a paginated scenario."}]} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/list-test-builds.RequestSchema.json b/docs/release-management-api/build-distributions/api-reference/list-test-builds.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/list-test-builds.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/list-test-builds.StatusCodes.json b/docs/release-management-api/build-distributions/api-reference/list-test-builds.StatusCodes.json new file mode 100644 index 00000000..48d30581 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/list-test-builds.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Test builds","content":{"application/json":{"examples":{"200 - Test builds":{"value":{"items":[{"app_name":"IOS app title","branch":"master","build_number":"112","build_slug":"build-slug","created_at":"2025-02-11T09:26:01.000Z","download_url":"https://download.url","filename_ext":".ipa","filename":"test_build_1.ipa","id":"d9a69b7a-8a0a-4ce0-8802-cc5c7bf0d6eb","public_install_page_url":null,"platform":"ios","signature":"enterprise","source":"ci","storage_provider":"gcs","store_app_id":"io.bitrise.ios","type":"ipa","formatted_version":"1.2.3 (123456)","version":"1.2.3","version_code":"123456","workflow":"primary"},{"app_name":"IOS app title","branch":null,"build_number":"112","build_slug":null,"created_at":"2025-02-11T09:26:01.000Z","download_url":"https://download.url","filename_ext":".ipa","filename":"test_build_2.ipa","id":"0bae7f60-9823-43f5-b5ef-be07d43eb6ae","public_install_page_url":null,"platform":"ios","signature":"development","source":"api","storage_provider":"gcs","store_app_id":"io.bitrise.ios.example","type":"ipa","formatted_version":"1.2.3 (123457)","version":"1.2.3","version_code":"123457","workflow":null},{"app_name":"IOS app title","branch":"master","build_number":"112","build_slug":"build-slug","created_at":"2025-02-11T09:26:01.000Z","download_url":"https://download.url","filename_ext":".ipa","filename":"test_build_3.ipa","id":"2316c477-ce65-408c-978d-e0dfd9cf0bc6","public_install_page_url":null,"platform":"ios","signature":"ad-hoc","source":"ci","storage_provider":"gcs","store_app_id":"io.bitrise.ios","type":"ipa","formatted_version":"1.2.3 (123458)","version":"1.2.3","version_code":"123458","workflow":"primary"}],"pagination":{"current_page":1,"items_per_page":10,"has_next_page":false,"total_count":3}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/list-test-builds.api.mdx b/docs/release-management-api/build-distributions/api-reference/list-test-builds.api.mdx new file mode 100644 index 00000000..5031f3d1 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/list-test-builds.api.mdx @@ -0,0 +1,69 @@ +--- +id: list-test-builds +title: "Get a list of test builds" +description: "Gives back a list of test builds for the given build distribution version." +sidebar_label: "Get a list of test builds" +hide_title: true +hide_table_of_contents: true +api: eJzVWNtu20YQ/ZUFgSKJIUqUZEm2kAtc2HWFOk7gG9AkhrAkh+LWJJfZXUpxBb/2A/qJ/ZLOLCmJtuTUdgIE1YMk7mXmzOyZy3LuhKADJXIjZOYMnUMxBc18HlwxzhKhDZMRM4C/fiGSULNIKmZiYBNcmJWDLMR1SvgFyWBTUBp/m07D0RAUSphrZ/hx7hh5Bajh4+XNZcMxfKLxv/Oz3b9f268dnJY5KE5PoxAxHeH0GUKwizXKzbniKRhUZCVn+IDLeJ6PRYjTggz5XIC6xgcFnwuhAOUYVUDjjrlnaElRiPBim4kQMiMiAcqajBMo0P6S+Tg6UbLImdAskFkGgYGQGWnNDGJIuTNEG69zQkLWZBPn5qaxBFd55fHoqo0LTOsOfygCYSDVY3TsOOcTuB9IxBMNdZEhRLxIjDNsew0n5V9EWqTOsEcPIisf2o2FYpEZmIBybu7acppDQN7V1oxKDMuK1K8cXuOYAlOoDP2LaBkhw7mmU7PlyRY8FfMsFkHMSC3TsSzwCHxYwYyUTK1Zs1gmNK5RG9NgmMgwjHCbyDjxRQeQcSWQNRQEuC5HwoMmjB3PK6HeIsDKKWgh8s4gR2kZUjMRgQ2R1h+a1s4d+MLTPFlKYy6rb8fBKU8KoD+WCjZ0KGYqn47enZaMFyYh5/qKZ0GMEykn+tMISRqXR4bj7XZnOaiTYoJD9sG1DwhXARk95ogYAXV6rtdx2+0zb3fY6Q+9dtPzvA+4LpSzLJE8HBcqwZWxMbketlqL4SYNN5xIJEBIx/CF5DVFzmujOEIEGpdo2tWsoOwR7vL+rj/g7g73uLsdgOfu7CCSIOgFAz/ywj74lFMKHz06Fpk2PElsjJSAsiJJcDrhBlNfSnSRdBhaTPBMC0Wq8VBA5Upo8puWhQpoNBD0ZKQiUbmSU8ww5LdJoKsJGFc5i4Q2fWFIRLOUv+BmaSZq5oacucgj6P5mp9llz9ud7nav/wIX3ZlajYwDGZKscimOz6S6ihI5o0hSIuUYPxRcDyBD6Yz/JEK57McRoFMngOdzGER9z93d6XTd7W7Uc/0eRK4P3iDc7oLf5/CNBAhhConMU4rOGgN4/nQKNKtwfiwVBg+nwuAWFcjMB7Lgf5gSunVGdLrtfrA9GLgB9HvutrcTuLuDndAFL4zC3SDy/KD/jYzgoRvL4Aelg52Hc2DnnnRwSV2WLVuirC7YySmkd9k8UPG800/Y7iDmepzhaVRDVSE2Ev2HWguqXd2b8tNwtr32esU7z3hhYqnEnxA+ruShOCx5t/bXa15l9MHJyfj8eO/87Nd3J6MPB/uoIwWtLdzbylcwu+sw34NKhbaNGbaN4vFYu4h1Xcg9gN8fnLwdnZ6O3h2P9w+OR3dQr4tZQO9t6ilGVKwynrBTUMgIdqCUVI+D37PdxWZB95gwOj47ODneO7qF/FRiFx9jo8pmqJnNlLQ9a4We5iQFwwSMbfoNpZ4WBbW77Im01V02M2WymPtcw/nJ0U1LQQL43015hvooObemnVaZkOodtG5N2xQe2JlxvzKxEnKre1zmIczrtfB0NrXtJS5GYhjKYTNhYtsi2q4UmmTm5eqGdGpHrebqnrRs5VHZb3C96HZj4KHNvHf4uHfG8E5CnlXXeC1hBerdez9iAWYu8tPijlTxuwxr8rLIImm12Rw/dE5Kp7G3S6dZOS7bdFWrZ5lpp9lew7W1dSTlFZ3w4t4oUQgKfLO1xX6XBeLLWCSykAnDYlAwZC85ixVEr55tOj90hhvKQLdwC3xpxiZN3uCx62aVuI7RzFeVCT91vJUR+IBa8fuijV/7KOIZM1whtV49G/sJz66evb5oW1M1dv0vW/z1p+xTdrZCjEeYJNT2h5ArCGw/jyH3C/iqIKe3sdfGkjZoouuu8JyxDqDB3LBrNDPmU7z0iIni5bXRuiKDmRXsAzqHFkPWJKVf9UApBL3rTvDeCtYFG0wRKJt0oE3//PU3u+iwt4uN7JA2koV048mlNiieKFBx5BCM3nz5v3u881XS+L4vDirqGywlLSyzyHxEasN7XuWBj049D2AkxWgHDc/L+FfJzQ0Nl7dDyg6oi6J7dT+815TnJ9VV8gX7Lu8HNlpzhTFde2dR5UzHNuJPhvqglwVfgbN6S/FEPN9+y/8qvrV3GN8M87tf7L+Kfw315ars2FdjjUWCJ8aWe/aCAHJT27VWnUnKslgeHpzhWsrzt2vIla0h1R/7Pq6ayq7rsm/VhwVs+iYHb9wyn5cVCuNtSSM7de+OZQ2rDpUswHL4L9Ev9T0= +sidebar_class_name: "get api-method" +info_path: en/release-management-api/build-distributions/api-reference/release-management-api-build-distributions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gives back a list of test builds for the given build distribution version. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/list-tester-groups.ParamsDetails.json b/docs/release-management-api/build-distributions/api-reference/list-tester-groups.ParamsDetails.json new file mode 100644 index 00000000..513c8f4c --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/list-tester-groups.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"app_id","in":"query","required":true,"description":"The uuidV4 identifier of the app the tester group is connected to.","schema":{"type":"string"}},{"name":"items_per_page","in":"query","required":false,"schema":{"default":10,"maximum":50,"minimum":1,"type":"integer"},"description":"Specifies the maximum number of tester groups returned per request."},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer"},"description":"Specifies which page should be returned from the whole result set in a paginated scenario."},{"name":"type","in":"query","required":false,"schema":{"enum":["internal","external"],"type":"string"},"description":"Tester type. Defaults to internal."},{"name":"installable_artifact_id","in":"query","required":false,"description":"When provided, each tester group is decorated with `notification_sent` (whether a notification for this artifact has already been sent to the group) and, for external tester groups, `custom_access_link` (the access link sent to the testers: id, name, url, expires_at, access_code; omitted when there is none). The access code is not exposed via the public API.","schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/list-tester-groups.RequestSchema.json b/docs/release-management-api/build-distributions/api-reference/list-tester-groups.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/list-tester-groups.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/list-tester-groups.StatusCodes.json b/docs/release-management-api/build-distributions/api-reference/list-tester-groups.StatusCodes.json new file mode 100644 index 00000000..20885983 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/list-tester-groups.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"External tester groups","content":{"application/json":{"examples":{"200 - Tester groups":{"value":{"items":[{"id":"d4267035-b75a-450c-b46f-34cad2706a75","name":"Internal Group 1","type":"internal","auto_notify":false,"notification_types":{"email":{"enabled":true}},"tester_count":3,"enabled_notification_types":["email"]},{"id":"a4051ba6-0d4a-400c-bd33-b34fcdf92f93","name":"Internal Group 2","type":"internal","auto_notify":true,"notification_types":{"email":{"enabled":true}},"tester_count":2,"enabled_notification_types":["email"]}],"pagination":{"total_count":2,"current_page":1,"items_per_page":10}}},"200 - Tester groups decorated with notification details":{"value":{"items":[{"id":"b2d3a94c-ae53-4ae9-8de3-39968cf642cf","name":"External Group","type":"external","auto_notify":false,"notification_types":{"email":{"enabled":true}},"tester_count":0,"enabled_notification_types":["email"],"notification_sent":true,"custom_access_link":{"id":"c0ffee00-0000-0000-0000-000000000001","name":"External Group","url":"https://app.bitrise.io/app-install/example-token","expires_at":"2026-07-24T12:00:00.000Z"}}],"pagination":{"total_count":1,"current_page":1,"items_per_page":10}}},"200 - External tester groups":{"value":{"items":[{"id":"0587a94c-ae53-4ae9-8de3-39968cf642cf","name":"External Group","type":"external","auto_notify":false,"notification_types":{"email":{"enabled":true}},"tester_count":0,"enabled_notification_types":["email"]}],"pagination":{"total_count":1,"current_page":1,"items_per_page":10}}}}}}},"400":{"description":"Invalid type value","content":{"application/json":{"examples":{"400 - Invalid type value":{"value":{"code":"ERR_VALIDATION","message":"Invalid type: `not-a-valid-type`. Valid values are: internal, external."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/list-tester-groups.api.mdx b/docs/release-management-api/build-distributions/api-reference/list-tester-groups.api.mdx new file mode 100644 index 00000000..42a94f93 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/list-tester-groups.api.mdx @@ -0,0 +1,69 @@ +--- +id: list-tester-groups +title: "Get a list of tester groups" +description: "Gives back a list of tester groups for the app. The `type` query parameter selects which groups are returned: `internal` (the default, Bitrise users) or `external` (email-only testers). For example, `?type=external` returns only the external tester groups." +sidebar_label: "Get a list of tester groups" +hide_title: true +hide_table_of_contents: true +api: eJztWOtu47gVfhVCQDGbgWXLt2Ti7uwgi2RTo5nsIPGk6GYDh5boiI1MaknKiRv4bx+gj9gn6TkkZVvxpcnMtD+KHQwcSSTP5TuHH8/hU5AwHSueGy5F0AtO+ZRpMqLxPaEk49oQOSaGacMUuVOyyDUZS0VMygjN8zoZwMOtmeXslvxWMDUjOVV0wnC6ZhmLjSYPKY/TcjFVjChmCiVY0iO3XMBMQbNb8h2KTNiYFpmpkR+5UVwzUmim9B4BjbfscTGVTSjPQimymTdN79XJTzCJPdJJnrEauf2ANr1frnE6NXGLQFU5VHWuHtQCzeJCcTMLetdPgZH3DHC5vpnf1AJD7zQ8BwO35NQuCWBA5kxRRLCfAIZnAJub4mfUggUq2koV8AITAcEhT2CYI/QWP3hR7LeCKwaSjCpY7VmAEPCi4MlVh/CECcPHHEzBILmQ2L+rPhGuSSyFgFiwhBhpXYxTwDDogX8AE0jVALe4C+bz2sI4bthED8GxYU7v2HYjxzTTbFWkD2LQa0a1YEIf+aSYBL0uvnDhXpq1UjEmwB1Twfy5n5c5i9E3bR3yYogoJiPvbiUny5QiYC9B22C0Hqx488U+fKnVLutRLdGpLLKEjJaZT8ZKTqxjD6nM8LsGbbBjDOECNh4s44JivHTMBFVcVpyxVrzcGSbQ+uug3Gwwu8x+TN5nKbCWcA5onFUnxw4XCIokpbiKaVxoQ7OMjjI2pAqyk8ZmZ457a6s6/5IyQXIlp5DiSY0wClA+z+mExVJZjB64ScmtkLgXYrsNhxp2BhDFQ8oAZAWIro56BuPIRs5CklJ4yRSjyQziBMpRADqJMbIq9wgVYMrYsswm6gDSiQtt5GRI45hpPcy4uPe85r4Q/FKR7NmrB1u5RhDBGilUBg4/5oCOHlKgQi8tlgn7I5ETbqzLCBC6xhAKIQXbc1zsNeFsN2JQmNSwZsqpVZoXo4zH5OhTfzcV3GCYdC6FZhrHW1HktsZqpE42YgFygXIMeIorgJUyD33jbxqXQU46pi4Fk5AMKgLg85RmBcMHy0SWNznSa9Jp7R9E7W44OujSsNON4nDU2R+H7U5Mk9ZBtE8PumCAT8i+z1LH1qQZVDax3w60MHJoU2S2yMhKPuESa5Q9etymwhz3JA28GTgAIE4Fet2ulTOGmwRde0E3uHWsV7QTdZsjuh9GSQe8itCrpN0OR+3OOE7Gh63xYXurV63/7JU7S77OqdZLnbrBE89SGHfhNhJYYUUMnLAKssMdLUisz04bODvmqH9Dajzf+JWdnTADFuxMn1EradPDThxS1m2HHcoOw3cJa4ftw8P9d/F4v9OKx0ugF/ltgV7CvCDQ/0byRC/E+ZkebfebC/Q6FVkoEIA4Go8Zi6IwitZ+/L/mDgCAoOBzakyue40GFoEjV6zVucTX0B8BDb/FQ1dC4ZlTkhqsb0UtSPWDsNUZNFu9KIL/dVD8i+OdHcnTfG3ybGGoHRkSdd8d/J9kyLcCc24B7Ww6AfoCcOSJLRCIg/RV7N+xUdogZTVCeJ4h1hcXw6ujs/7x0aD/8znomUB2WysrZvRsNRDS0H4KbXtSJ1d23Iq0fUhvUcHUFkc61DILX5vrvn4WEMpUKv53lrzWyyZ4WVm/xb/P50efB3/6+aL/y8lxxcPK4qWZ7XUzPzE14Vo7QhT89ba2wdZ1IVsM/nRy8bF/eQkBGR6fnPefWb0upjS9uzmb/G66ZGoKu/VEKaleZ37XJ9QmQVtc6J8PTi7Oj84qll9K6NhSqIXIA5ZsD0rasshbj2MS2eKOGdvgmRReGm6bhosySFvtjlwccz6NqGafL87mDQUNMjyHEypA4wSUNKatxqjgWRImHOuwUYFe6sYUCXkKfQBueeukF1LpVVZIma+QcrCphXR2ERRDQI47SrE6tPUgs/vgZtkLX9qv2hGI7YgX9SIo+zOblQV+CiU0U2sqPx0NCHSgiK2aYfULjT1WoCSGk0IvybTMcEdXiDMXY2m1cZPhjAsHGvm4AM3KCcmPiBs5XsUNQQPwnQnTVr25Ztfbt2dS3mOMy1sNCUJA4Ie3b8lfZQH2QbvARUI4NAkMSeN7SlLFxu/fbIofgBEmMtYNWMIe66mZZB8g7LqeKz4B18/BzffehT+0oqUT8AJa4feqCT/HIOINMVRBcr1/MxxlVNy/+eGqaV3V0GN+36A//Cp+FYOlxRDCLMMmM2G5YrEtkGDT/cRGqkDQm9oQOHUP6gDdPcS5gN7BpNSQGbiZ0ik02fzO1VW+OxHswQoeMQAHJzNRR6U7EXBCAN3wroDuzUKwwRUOslEH+PSvf/yTXLXIx3IhOcWF6CE2o9C7GBCPKeBz5JRB/7nlcup5gJ+WxPH71daiNDEwo5FnFHbs3Bd0T57BroMqgwEHpBABHHhyzKWy+Rw/u1YeeQ24yhcrm5r51RB8d+H7/j3yTe6xNvpzD2y0crfm+T6wtxQvN/Vb3D/tNHDtfu2rDf3mV0477f86q19wq7RTu78C+0Ltv98v/c/ul3btgK13hcuw3izrHnsLXysrDCQeJ+YITMrNyqq1AhGlLOq105OBa8nSahFzb4sY/2Cv/v2QmK3KrhQopSf4ixm4ccnTkyuRgDbL+W5o64pFEVXiBB5APfZvpOznXw== +sidebar_class_name: "get api-method" +info_path: en/release-management-api/build-distributions/api-reference/release-management-api-build-distributions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gives back a list of tester groups for the app. The `type` query parameter selects which groups are returned: `internal` (the default, Bitrise users) or `external` (email-only testers). For example, `?type=external` returns only the external tester groups. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/list-testers.ParamsDetails.json b/docs/release-management-api/build-distributions/api-reference/list-testers.ParamsDetails.json new file mode 100644 index 00000000..ef7f35ab --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/list-testers.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"app_id","in":"query","required":true,"description":"The uuidV4 identifier of the app the tester group is connected to.","schema":{"type":"string"}},{"name":"tester_group_id","in":"query","required":false,"description":"The uuidV4 identifier of a tester group.","schema":{"type":"string"}},{"name":"items_per_page","in":"query","required":false,"schema":{"default":10,"maximum":50,"minimum":1,"type":"integer"},"description":"Specifies the maximum number of testers returned per request."},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer"},"description":"Specifies which page should be returned from the whole result set in a paginated scenario."},{"name":"type","in":"query","required":false,"schema":{"enum":["internal","external"],"type":"string"},"description":"Tester type. Defaults to internal."}]} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/list-testers.RequestSchema.json b/docs/release-management-api/build-distributions/api-reference/list-testers.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/list-testers.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/list-testers.StatusCodes.json b/docs/release-management-api/build-distributions/api-reference/list-testers.StatusCodes.json new file mode 100644 index 00000000..738c22a8 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/list-testers.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"List of testers","content":{"application/json":{"examples":{"200 - Testers of the connected app":{"value":{"items":[{"slug":"user-slug1","username":"user-name1","email":"user@example.com","tester_groups_count":2},{"slug":"user-slug2","username":"user-name2","email":"user2@example.com","tester_groups_count":1}],"pagination":{"total_count":2,"current_page":1,"items_per_page":10}}},"200 - Testers of the tester group":{"value":{"items":[{"slug":"user-slug1","username":"user-name1","email":"user@example.com","tester_groups_count":1}],"pagination":{"total_count":1,"current_page":1,"items_per_page":10}}},"200 - External testers":{"value":{"items":[{"slug":"external@example.com","username":null,"email":"external@example.com","tester_groups_count":1}],"pagination":{"total_count":1,"current_page":1,"items_per_page":10}}}}}}},"400":{"description":"Invalid type value","content":{"application/json":{"examples":{"400 - Invalid type value":{"value":{"code":"ERR_VALIDATION","message":"Invalid type: `not-a-valid-type`. Valid values are: internal, external."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/list-testers.api.mdx b/docs/release-management-api/build-distributions/api-reference/list-testers.api.mdx new file mode 100644 index 00000000..eff8dfb4 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/list-testers.api.mdx @@ -0,0 +1,69 @@ +--- +id: list-testers +title: "Get a list of testers" +description: "Gives back a list of testers." +sidebar_label: "Get a list of testers" +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v2zYQ/iuEgCFb4JfYbTHA6Ms8xMuMpmngOAG2NHBp6WxxlkiVpJx4hr/uB+wn7pfsjpIsvzdpO+yLI5LHu+c53vGOmXsBGF+LxAolvZZ3JqZg2JD7E8ZZJIxlasQsGAva1LyKpxLQnGS7AUqfo0A/W8Q1A36qhZ15rdu5Z9UEUOHt3eKu4lk+NvjtFbI4lXDNY3AjEpc4QIU8SQYiQF2CwHxKQc9woOFTKjSgRatTqGxA7ofA0lQEN8+ZCEBaMRKgHWxcQIXub0aBjbVKEyYM85WU4FsImFXEy/ghxNxrIfBZQkiM1UKOvcWisgSX6Rg4HQdRjnhkHg+Tr4F7LBhhITYDPI1BwsfwWSylygBGPI2s12qcVLyYP4g4jb3WCxoImQ0alcKwkBbGoL3FJpurBHxiYJx3czVMpvEw93120kyDTbVENyNSRqhwvuat8Phi9F+K9z4UfsjILDOhSqOADaGEOdIqdpTuQxXRvEFrzIBlQuJJ4TYhOYWN8UFyLdQaGYfi8WRAEvpbh1pLHqE0POSfd5XNw98KqCxqSKrGTjO/4HEoVqhDaHdk3yRKGjBksXlyknlxVdH5epojCswOiyFKophAkfBdytf/MCSPuB94nERLjazK8sQusq7MLtxOUlMepUAfLmxdxpsoHaPx1ICu0ncD7dIgd6Wbp2+aR3+JKJ/8Kbde81WMS6tJaQa+Sgl2k85k00Bzj4HmhoHmYyw0Fu4Oc9EgMq9YZXm0RIBOTLVGJ2b5STG6kbKYgAvM6N0eXL0S/gcHfo5e46n0OnlcL4PsIKciCzagluxkGkUlqz3i/y2zhWP3fFdCdSVSE4FLTZaxfFJOPXcu26Fl1Wm+CuiYO73e4KZ93j1t97vvL9BODMY4lGswWuyjVLbKq26qSlMfa+zGrTuVhnGNUsXdUWGFU/EWWXJtbHO9ljy1odLiTwieyrKBLNf27+F3fdG+7v/6vtf9vXO6xnBtcwnz2TbMS9CxMAYHDIuveDrWZ4h1W8kewJed3rvu1RUeyOC0c9HdQL2tpoD+Ync05alzBXqKd0JHa6WfBv9FHlC7FO2h0L3od3oX7fM15FcKW7YQqxG7R8vsXivXleToaU1RWzgG61GS2RAHdbvSIJLdLNNTTZk7H3ID173zRV1DBPhdjblEWzGqr0+b9WEqoqAaCKqBw5T4mfqULrQp1l4+zOnlStb6Ay+0NjGtep0nojYUuN9ATShvV1uW4WKkhqEedi9s6G5hV6rBZcBd2d9euVmTXR2uy102amjsLcyKFiAEHoDeMnnZ7jMsj+RVPaOCjfcaa192mc+jiPxUNMN5bGcXFXlYyJFy1oSNSKKXOY29WzrN6amyn8lv7HTVb+Q0dH4GYdqsNbZwHR+fKzWh0x0p7fgrVIIK3xwfs99UivgkGwkZMGFZCHRdvOQs1DB6dbTr/NAZ1UD5po5b4KEW2jh6g8duaokWMVK/QJqvcgrfNU9KEjhAq/h708CfU1RxxCzXGFavjgbDiMvJ0eubhqNqsK97WeevP8gPsl8ixiOMImrsAkg0+K5jw3T7BYY6Jac3sONpnjR/rKHrJnjOqcaSG3LLZkgz5FNsacVY8+x94Fwh4d4pHgI6h4RB1sjoQQ9kStC71TF2/uBcsIOKQN1kAzn989ff7KbJ3hUb2RltJIbUACbKWFRPIZDHyBlgz7f1Uts82nl5WXz2hZdHssX7v55EHAMZDbtsnecpfevZ8h0XIiSammeprKPFgqaz7pcSHZOXEnXPs2gV2fe9vFX+gX2TN91OJhNMz5V3Zn71ea6LfzzUJzzmDqDYflB+IZyve40dxLj1zvxqiN/8AXYQ/9ehfsQb6/AJZw/C0vpdWbrcP0cqRZGgVMn2tH0fEruya6u6k5ZlsT3r9FGWasV6HZq4OpR/uP/I5Etytqp7rcYUsOmXHLVzy3yeVTlM9EI+W9q7Y1kH85AiBlhS/wVyPWD/ +sidebar_class_name: "get api-method" +info_path: en/release-management-api/build-distributions/api-reference/release-management-api-build-distributions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gives back a list of testers. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/notify-tester-group.ParamsDetails.json b/docs/release-management-api/build-distributions/api-reference/notify-tester-group.ParamsDetails.json new file mode 100644 index 00000000..fa360ba3 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/notify-tester-group.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the tester group.","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"enum":["internal","external"],"type":"string"},"description":"Tester type. Defaults to internal."}]} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/notify-tester-group.RequestSchema.json b/docs/release-management-api/build-distributions/api-reference/notify-tester-group.RequestSchema.json new file mode 100644 index 00000000..3ef4db30 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/notify-tester-group.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"test_build_id":{"description":"The unique identifier of the test build what will be sent in the notification of the tester group.","type":"string","example":"test-build-id"}},"required":["test_build_id"]}}}}} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/notify-tester-group.StatusCodes.json b/docs/release-management-api/build-distributions/api-reference/notify-tester-group.StatusCodes.json new file mode 100644 index 00000000..b2b63268 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/notify-tester-group.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Send notification","content":{"application/json":{"examples":{"204 - Send notification":{"value":{}}}}}},"400":{"description":"Tester type mismatch","content":{"application/json":{"examples":{"400 - External tester group":{"value":{"code":"ERR_VALIDATION","message":"External tester groups cannot be notified via this endpoint. Create a custom access link with tester_group_id to notify them."}},"400 - Parameter missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: test_build_id"}},"400 - Test build cannot be found":{"value":{"code":"ERR_VALIDATION","message":"The provided artifact cannot be used for tester group notifications, id: `e8469a17-5fe8-4d59-abad-52fc8a94e729`"}},"400 - Test build type is not supported":{"value":{"code":"ERR_VALIDATION","message":"The provided artifact cannot be used for tester group notifications, id: `b6690148-4e1f-4d66-a554-d25c24397a42`"}},"400 - Test build is not distribution ready":{"value":{"code":"ERR_VALIDATION","message":"The provided artifact cannot be used for tester group notifications, id: `dde4bfd4-c9c3-4fb8-bb1c-85b34aaf8da9`"}},"400 - Invalid type value":{"value":{"code":"ERR_VALIDATION","message":"Invalid type: `not-a-valid-type`. Valid values are: internal, external."}},"400 - Tester type mismatch":{"value":{"code":"ERR_VALIDATION","message":"The resource is of type `internal` and cannot be accessed with type `external`."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to notify the tester group. Only Admins, Owners and Workspace Admins can send notifications to the tester groups."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/notify-tester-group.api.mdx b/docs/release-management-api/build-distributions/api-reference/notify-tester-group.api.mdx new file mode 100644 index 00000000..bd30267d --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/notify-tester-group.api.mdx @@ -0,0 +1,69 @@ +--- +id: notify-tester-group +title: "Notify the tester group" +description: "Notify an internal tester group about a new test build. To notify external tester groups, use the custom access link creation endpoint with tester_group_id." +sidebar_label: "Notify the tester group" +hide_title: true +hide_table_of_contents: true +api: eJzNWOty4jYUfhWNZzppMxgCgdxmL8M2dMs0IRlC0ml3M4lsC9BiW15JJksZ/vYB+oh9kp4j2YDBbMuvbX4QYx0dfef2nSPmTsCUL3miuYidC6cnNB/OCI0JjzWTMQ2JZgqeyEiKNCHUE6kmlMTsxSwQL+VhUCUDQWK7lX0p2acqJFWM6DEjfqq0iAj1faYUCXk8Ib5kFM8nLA4SAQeTF67HmYIno+CJB1Wn4oiESSPaDZZgB0bsPUqBhGJ+KrmeORcf5o4WEwZWfXhcPFYcTUcKnh0rT8wG5cBCQiWNGLxTZlMMX0A5D0AbR58kVI/hueioAZiSpjx4aBIesBiAcFAqhsbGddMRtmSfUy4ZYNYyZQDSH7OIOheAcJbgYUpLHo+cxaKyPN+sZAg+p0zOCnqGNFQFRSxOI7QuDxtI55FAGzfO2bLGAkapKrlkQ5qGWhEtlllQddCFkqlExIopPLFx1MR/RUV3EEKbCdw3gQIcvgAlsUZhmiRhtlD7pHAHIP9CoyRc6iQu2VYCS1MapmDCfGH+Kk7z6Gj7+DU7SMRVRLU/3g8BqAUEnbIkXkcBKgN0aKfff3poX3Uv24PuTQ+OiiCr6cgslRYC8WkMphGPZRaygEw5hbThapn/VfIjlgSDQispl7LiwFhlBQgJGFWdzEVgy22e3ugRheHfYcdtu9++7gw6/afr7t1dt/e+YI6pEgIgMy1ESJPrRhO+Z1GiZ/iWx/COBxcG45MhCEC4hmiwJI41bwxFGgd7uhiLMJFiChUYECrBfOrrNZ3AOQEolkUOW88sICZE+szOmifntH7qtobszG0GrXOXejRwW42hf0bPm+y0cf5cboJJNrAfz1Rpkgip2bczxDs5OT+qN8EGVh+CIScnLm21mm7QaPmN5vH5KW02dhiS2RBwZAkvNYwMaRjMvpkxQcCa3jBouv65f+w2h96Z63l13z1recdNSodnAS1EpWszz4ZkiXgP6OsK4HzA5FLXvHLx1XOVPJh1o1KBcSCVU2Rl2fqqG/7dYqT9/QnMK1Lpm0TDJoPqnvOTn6Ffr5eSJQtwsmUKI5tje0ZwOYPWtxn0PqapHgvJ/2DBvsxZB3sL+3fYed9r3w9+vul3f+9cFiwtbF7BPN6Gecuk4SFIUei+fH+sx8iMW0p2MWOnbyjxpvd02el1N1D/JlIyplMkdJIsVaoiJRdnAnIThzPSDiKOuX7zEsPwYYL4q5ATlVAItF3EqBK12Q+N7k2lahXZVllv7OYD3R2TU9jUkVLI/dzWyqqsTNEO13V70FB67auCx+4ENKQxNpEXhtOeFGb4ydDjlAN2vROWef4F39YsJbxPzNdwHnAQhENzi73YjLYnB5znYv4Ze1npPJeR5MuY4ngahlhoCtHz2Misx2fXHFicwiq5b3HaA0nXnOBmrXI1633YwP5o3YQuFDgGJ0IZc3FMvXBq9lDX5kRtzoNFzaahmY4xYnbOTWUI4nOPKnbfv1rUJAsZPLsRjSFKEZhWmzZqFtN6T1C1aR1UTank1MsSI1Ni3WqmR1A91jpRF7UaTXjV47BfsSoXpZO0xUVQDQE9GXHhAkaXmcx+XA33d+atDasd8ZfRh8N+YbN8cB5D+2Jy68jb9gBuMEiSVM6wlvBy0r7tQrWFoQLxbAbP2cgOoeh0zLr+Kj87eQC38mszoghoKIwg1ybkfetvcr30t4Hgkncm0S7XXY7+hrhZ9NNGtb5l0uHhlRATLKlhNpgJUAIK3x4eEmQoJJIhByLhmowZNq5XlIwlG74+KAs9+NENhK9qsIV9qY51FL6FjFHVRPIIvNYDD73OTPiucbQyAr7AqfD5UIePS1BxQDSVI6ZfHzx5IY0nB28e6sZUlTD/VY2++Rh/jAcrxMvyClgiGVQUdDKoqZ+YJ1OMVx2KsXHUOK2C6yaQIqnEmyWU5Swn4oiPpNmW0STeVlGxx8A55hoaV/HQr3rAKgHvuiO45zHjghJTON6E4Qyw6e8//yIPDXKdbyTvcSNaiPHHMgX1mAJZevXKu8NmbNco8P9+P8+KUMMhtSSkUINguCGaecZPlsyW/AR7LsxNO6MoKPIx0hnIzS01yXCxwNf2DozEBWSExLO6Be/01n+41u7APAEOWd7Bs77mmDtwznt7Qvm+n/H5D2Svnw5K0eVcF8/W0eWokW4eQSojP8RpF360aNxB0aytroq/QtgdbciCRH9V9nGtE93e3A1A2Ms6d2THAElf8LcL+DQgRWIpDQTMu7kDlTRK7WRgdSLTIvcWeX1ieD17MD/vlLmhyNm5T/ATzSrdMp/brgGJlsvbpZ07ln0l8zj6AVD/A9vPp+s= +sidebar_class_name: "post api-method" +info_path: en/release-management-api/build-distributions/api-reference/release-management-api-build-distributions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Notify an internal tester group about a new test build. To notify external tester groups, use the custom access link creation endpoint with tester_group_id. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/release-management-api-build-distributions.info.mdx b/docs/release-management-api/build-distributions/api-reference/release-management-api-build-distributions.info.mdx new file mode 100644 index 00000000..512a666e --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/release-management-api-build-distributions.info.mdx @@ -0,0 +1,81 @@ +--- +id: release-management-api-build-distributions +title: "Release Management API - Build Distributions" +description: "**Looking for the old API?** You can find it here: V1 API spec" +sidebar_label: Introduction +sidebar_position: 0 +hide_title: true +custom_edit_url: null +displayed_sidebar: releaseManagementSidebar +--- + +import ApiLogo from "@theme/ApiLogo"; +import Heading from "@theme/Heading"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; +import Export from "@theme/ApiExplorer/Export"; + + + + + + + + + +**Looking for the old API?** You can find it here: V1 API spec + +The old API will be deprecated on February 1st 2027. Make sure that you have migrated to the new API before then. + +View the V1 → V2 Migration Guide + +
+ + + + + + PAT necessary to use API calls + +
+ + + + + + + + +
+ Security Scheme Type: + + apiKey +
+ Header parameter name: + + authorization +
+
+ + +
+ \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/sidebar.ts b/docs/release-management-api/build-distributions/api-reference/sidebar.ts new file mode 100644 index 00000000..c824c471 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/sidebar.ts @@ -0,0 +1,102 @@ +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; + +const sidebar: SidebarsConfig = { + apisidebar: [ + { + type: "doc", + id: "release-management-api/build-distributions/api-reference/release-management-api-build-distributions", + }, + { + type: "category", + label: "Build Distributions", + items: [ + { + type: "doc", + id: "release-management-api/build-distributions/api-reference/list-build-distributions", + label: "Get the list of the build distribution versions", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/build-distributions/api-reference/list-test-builds", + label: "Get a list of test builds", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Tester Groups", + items: [ + { + type: "doc", + id: "release-management-api/build-distributions/api-reference/list-tester-groups", + label: "Get a list of tester groups", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/build-distributions/api-reference/create-tester-group", + label: "Create a tester group", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/build-distributions/api-reference/delete-tester-group", + label: "Delete a tester group", + className: "api-method delete", + }, + { + type: "doc", + id: "release-management-api/build-distributions/api-reference/get-tester-group", + label: "Get Tester group details", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/build-distributions/api-reference/update-tester-group", + label: "Update tester group", + className: "api-method put", + }, + { + type: "doc", + id: "release-management-api/build-distributions/api-reference/add-testers-to-tester-group", + label: "Add testers to a tester group", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/build-distributions/api-reference/notify-tester-group", + label: "Notify the tester group", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/build-distributions/api-reference/list-potential-testers", + label: "Get a list of potential tester candidates to the tester groups", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Testers", + items: [ + { + type: "doc", + id: "release-management-api/build-distributions/api-reference/list-testers", + label: "Get a list of testers", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/build-distributions/api-reference/delete-tester", + label: "Delete a tester", + className: "api-method delete", + }, + ], + }, + ], +}; + +export default sidebar.apisidebar; diff --git a/docs/release-management-api/build-distributions/api-reference/update-tester-group.ParamsDetails.json b/docs/release-management-api/build-distributions/api-reference/update-tester-group.ParamsDetails.json new file mode 100644 index 00000000..fa360ba3 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/update-tester-group.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the tester group.","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"enum":["internal","external"],"type":"string"},"description":"Tester type. Defaults to internal."}]} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/update-tester-group.RequestSchema.json b/docs/release-management-api/build-distributions/api-reference/update-tester-group.RequestSchema.json new file mode 100644 index 00000000..b4db3566 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/update-tester-group.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"My favorite tester group NEW","description":"The new name of the tester group. Should be unique in the scope of the app."},"auto_notify":{"type":"boolean","description":"If set to true it indicates the tester group will receive notifications automatically."}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/update-tester-group.StatusCodes.json b/docs/release-management-api/build-distributions/api-reference/update-tester-group.StatusCodes.json new file mode 100644 index 00000000..0e278497 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/update-tester-group.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"External tester group","content":{"application/json":{"examples":{"200 - Tester group":{"value":{"id":"70241777-dafa-44a6-ae22-0548d7953e8d","name":"My favorite tester group NEW","type":"internal","auto_notify":true,"notification_types":{"email":{"enabled":true}},"tester_count":0,"enabled_notification_types":["email"]}},"200 - External tester group":{"value":{"id":"6d45127a-5d53-451d-9aa5-4ed3b45144f1","name":"External Group NEW","type":"external","auto_notify":false,"notification_types":{"email":{"enabled":true}},"tester_count":0,"enabled_notification_types":["email"]}}}}}},"400":{"description":"Tester type mismatch","content":{"application/json":{"examples":{"400 - Invalid type value":{"value":{"code":"ERR_VALIDATION","message":"Invalid type: `not-a-valid-type`. Valid values are: internal, external."}},"400 - Tester type mismatch":{"value":{"code":"ERR_VALIDATION","message":"The resource is of type `internal` and cannot be accessed with type `external`."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You have no permissions to update the tester group. Only Admins, Owners and Workspace Admins can update tester groups."}}}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"examples":{"422 - Unprocessable entity":{"value":{"code":"ERR_UNPROCESSABLE_ENTITY","message":"Validation failed: Name has already been taken"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/build-distributions/api-reference/update-tester-group.api.mdx b/docs/release-management-api/build-distributions/api-reference/update-tester-group.api.mdx new file mode 100644 index 00000000..df5a9df3 --- /dev/null +++ b/docs/release-management-api/build-distributions/api-reference/update-tester-group.api.mdx @@ -0,0 +1,69 @@ +--- +id: update-tester-group +title: "Update tester group" +description: "Updates the given tester group. Internal tester groups can update their `name` and `auto_notify`. External tester groups have no `auto_notify`, so for them this endpoint only renames the group (any `auto_notify` value sent is ignored). The `type` query parameter must match the group's type." +sidebar_label: "Update tester group" +hide_title: true +hide_table_of_contents: true +api: eJztWNtyGkcQ/ZWprUrJcbEgEIpsyk4KR8ShIksqhORyHJU07A4w1rKzmZlFJhSv+YB8Yr4kp2cvsAI51kueoofVXqa7T5/u6e5h6YXCBFomVqrY63iXScitMMxOBZvIuYgZnqzQbKJVmtRZP8ZDzKPKa8MCHrPUiZKk1Ow25jNxy3gcslueWnUTKyvHi9s6633eqWHK54LFqrq6xoxiY6VJ6QwXaZiIw0TJ2DIVRwumBdnJ4ZIi9ozHi6oSNudRKpgREIICOYmVFuG3dTaE0K1dJMD5eyr0giVcQxuBmqXGshm3wXSteg9msLju1TyVCM2JsX5YcjZ07ryllVhhRJBqaRde5+PSs+pOgNyP16vrmmf5xODey9YzJ2A8fCitGydEjkG5DKFNUmgSbqe4r8aLfEhTGV61mQzhoRxLKFVjB7sSOohq8Xsq4bvXsToVABmAVu51gBCOQZuxWsYTb7WqlfbdlxyBY6miZ8wjU1Ek4nRG3sk8T7Ba5AEnHx/Y2fImA+xoZsdizNPIgnXFCnV1jyjUwiQqNsKQxdb+Pv2rKtqZZMASKCiKLQnwJIlk4KLY+GRICug/81kSlXqZz4ab8njrcoluJEX+aL/Vbh4dHfkhH3O/3ebf+Vy0Wv7+YftFePTy8EC8oPDlVL5bsDGfK6RFNTTstPfeK7nZYG4ji4uQuacc9g1JOKwgX0YZ/XwUFQFGGL3Mzk2gUvJ6v1asuNml6GOu6JokM/93E7lFxHdh+7DZOuL+YXh44OM+9F9yfui3RXgwwmO7PW6uiSiVvt12v8yWB+7nmfZf+U9/Na+9K7c2kpTNpHFV4mmp1XbU9mNwKMNMUUlneROo0HE1GNxcdU/6x91h/+wUdlDuDJ/Qp00FHVRcZX3uu1e+q2p1duW+O5WGcY1VRXbVWEF03cs9XWd71bWngaKChP2pUh0IKrdUikjdbWE5awpoGMDLRoLxIICwCNm9tNN8bYHtlsAVoWhuh+IyRo5MsaP+EOFTQ9CEvxX5R/y8PO1eDn8+G/R/7R1XPK0Ir2EebMM8FxpsGjww1Gj5dKwHwLqt5BHA573Bu/7FBQJzc9w77T9A/UGlZa9NSpWuyK4b+IOmf0atthvOZGxq7Ow+RotyQXyv9J1JOAKdfayMAZvdfSOMrdauMCZaURbQ1mTUxeziiRS1Wi6cO/Q8GtbzwdmPvYuL7puT3k3vdNgffqgQ5faOs4iqLVEyOuwU5QvkwflICx4ukL40IHHq7oWDh7tKRjk1XQg9Bys9rZV+moeHec3YpegRF/unw97gtHtScetCYcaYovuyexqI7rVyDT9HT50dgXujwkWm7Iv4tuYHNfokAgt7iAOSy8oMe1b2H04ZtcK/f2+N2zNPLO4Zqd056rCLqUqjkKpLGkt4hLLnVpkAsAoReFSnEaTSZkqQI6UiweMt4/0xJklL24VaDJOYKeOQiMmn0Ar6exlFqIaBkG7DrTsOUghWUV/xHEWL9f6g4CjqqEnqeKSZr+M1Mq1+tpsaSxmu3IxJOZBNi6lG//OWI27E5eBk1dAC6I3wZzxG3GcIYmPeaoxSGYV+KCkCo9QBacypMc+5lrRpXLhyJVkauxkMqqfWJqbTaPBE1kcS8kbUpdoZmwwXIzUMevLC7uhHvgjn7PV6RL5wb53lfFAugwBjv4hFMX5OseeE3jJ53h0iHdy2xwxPdQx2u+d9RtSa9dRRVGsXANf0KI8H64zvFem4/MqJbWs+WxHSsXIeSOsye5AFgr0rA+Gw+ewNxYIdb8aCAoGAZm7NW/Xmlq/Pn58odUe7Nz8VMQUlUPjD8+eMSjtV4DEykhJzKqjjv+JsqsX49d6unADBfqgC04CI+Fyf2ln0A1LJ1BMtZ6CTKt7r3IVvWvtrJ/AAq7heNXE5hoo9FEI9Efb13s0o4vHd3vdXTeeqSUTwqsG//y3+LR6uEWebA1s0FAm2CDZQiDMd+0mMdEqBbOIE1tpvHdVB3R1yJ9XUmrhli6KDzeREOzHajHlNIMUjAXJcH4vrZPSLDGRKwK4/wTFKOAp2uCKhm2zAp7///Itdtdi7QpC9JUHykKpJooyF+o0kKo/U1aNIJbAbpfb/I/hXHcHzCmExKjaSiKNAgHxXBZd51fzoVaomZDo4q6DwTBEi+rzMyqWOVit6nZ1uqZiiQObHiPzU8WisvuLA+gjUO9S18nSdd2/PnW6LWvxEKM8G+an8W/akHwV2oivqb7zYRFegBo2ra6zKCzLhzD78mKHxh1W3tmYH+n0hk+hi+k/sF9deb3TF88sh1o7y8WSWzTqa39OPErg6jCrJiikWuHdLD3t4kmbjT6ZylbX9abXV3LlWk9+43212sVBtIwUldCWvdoosl1kjW63K9dmnRyXKVpcTTjQA9T+lTNO4 +sidebar_class_name: "put api-method" +info_path: en/release-management-api/build-distributions/api-reference/release-management-api-build-distributions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Updates the given tester group. Internal tester groups can update their `name` and `auto_notify`. External tester groups have no `auto_notify`, so for them this endpoint only renames the group (any `auto_notify` value sent is ignored). The `type` query parameter must match the group's type. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/create-code-push-deployment.ParamsDetails.json b/docs/release-management-api/code-push/api-reference/create-code-push-deployment.ParamsDetails.json new file mode 100644 index 00000000..9154effd --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/create-code-push-deployment.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[]} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/create-code-push-deployment.RequestSchema.json b/docs/release-management-api/code-push/api-reference/create-code-push-deployment.RequestSchema.json new file mode 100644 index 00000000..b3eceee7 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/create-code-push-deployment.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of your deployment."},"key":{"type":"string","description":"The secret key of the deployment. If not provided we will generate it."},"app_id":{"type":"string","description":"The uuidV4 identifier of the app."}},"required":["name","app_id"]}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/create-code-push-deployment.StatusCodes.json b/docs/release-management-api/code-push/api-reference/create-code-push-deployment.StatusCodes.json new file mode 100644 index 00000000..de455cfb --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/create-code-push-deployment.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"The created deployment","content":{"application/json":{"examples":{"201 - The created deployment":{"value":{"id":"9a35afac-81a4-488d-a986-3c13015d70a0","name":"Example deployment","created_at":"2025-02-11T09:26:01.000Z","updated_at":"2025-02-11T09:26:01.000Z","number_of_updates":0,"key":"random_generated_base64_key"}}}}}},"400":{"description":"Bad request - Invalid deployment key","content":{"application/json":{"examples":{"400 - Bad request - The provided uuid is invalid":{"value":{"code":"ERR_INVALID_UUID","message":"The given connected app id is not a uuid: invalid."}},"400 - Bad request - The name is required":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: name"}},"400 - Bad request - Invalid deployment key":{"value":{"code":"ERR_VALIDATION","message":"invalid deployment key"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/create-code-push-deployment.api.mdx b/docs/release-management-api/code-push/api-reference/create-code-push-deployment.api.mdx new file mode 100644 index 00000000..d069068f --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/create-code-push-deployment.api.mdx @@ -0,0 +1,69 @@ +--- +id: create-code-push-deployment +title: "Create a deployment" +description: "Creates a deployment under the given app." +sidebar_label: "Create a deployment" +hide_title: true +hide_table_of_contents: true +api: eJyVV+tu2kgUfpWRpVWkiIshSZugphVt2K61CYkIibRNIzTYBzyNmfGOx6Qs4u8+wD7iPsmeM2NzKZBt8oPYw5zvfOd+mHsRZKEWqRFKei3vkwZuIGOcRZAmajYBaVguI9DMxMDGYgqS8TSteRUvgzDXwsy81sPcM+oJEODhcfFY8QwfZ/jsXSwxMg+PVQqak6IgWqr6pCK4ybN4dRWRU675BAxoQkFBDVmqZAb4OveafoP+bfLuI7nQAkZrzBEqVNLQE0og7USElkD9W0Zicw++80maLIFZle1Bwu+nPMmBHgTRP+NHJ3zEw+ppgx9Xj09Poyo/O31TPQobR37jJHrrcx/1SzQEb3ecnh+4OTUDjvCovXlS9ZvVRqPvn7Wab1p+o+b7/he8l6fRT92T+WQIeqBGAyeBVvkV7wkwQp7mMlKTwRgkxQDBhjyDN8cD+nZh/yrese9ve/Yjj5iGP3PIDHonkOgFse4ZRgiv8jOqQaRNXPJ6qtVUROj2PEcNImPCKdvwfYj5Qv7s9QZB9759GVwM7u6CC2QwgSzjYyiSwWUqspIQUiiRFHOoUhlMb9LRKjXUvML8nbwohCRIp0LDXj437V77qtPv9AZXwe1t0P28QcrmNMFMRJYJOWbKlZRFonOYpGZGpwWpllW8l9meSOzhZj3V7gfX3Q1SYjfIKiF2lNqd5LmJlRZ/oSteGXgqsA35PXTvuu27/m/XveBLZzO0G8IrmkfbNG9AW08ridZJ8XquR8h1G2Rf7Ds9G/Tr7uCi0w1+YL0NU1I/2VVyAbLUkifsFvQUO29Ha6VfR//EZsxuoL3lhKnbbV9uML9V2IdjStdnSo5nreS4IL+gvmyz8aOKZg7sRX5ZGMOE05OZpQSuht+wOKnfaxoNRjjurmUub2VGo368td3xbWWqEZupXK/lMJZz0fZ+BgTHmAab9wRFJbmGxIKRbRjL3vQM7FkkCSsbKRNOHRo8cK3q/zVS77k/xnaEGsRIYGAKxXawlo51rebBuWOp4NF5nqKiaAylKnMT08T4Vo/WJi5NaAp7Zgd0rhO8MKe2f9e7XNQ1JIDP1QmXGGqSqE+bdcqHaorzuD5tIMCUa8GHRU4Voi5fRzxPaBzFxqRZq17nqagNBdqcQU2oPY62SUgwDHHQjya2ZtvEALKclodyrbi1p1ZzsVwsfYvKfrdTRxB2DBz3ky2VN+0+w+ZPqaxnzCiWo972TcBCniTZajSXDcUmq/U+JWxvldrF7F6l5iq2brYuX8skKE8WxHCkLHNhCMLrObezq6XbLacqKxch8jrGzNkwbdYaW4YdHl4q9UQ1OSpmiEoiQvlweMj+UDkaKNlISJx2hsWgocXecRZrGJ0f7Ao7erMaqTCrowh8r8VmknzAbMlqqRYT9F0XjT4veP/S9FfM8QW14ud9Az8uEOKAGa7HYM4PBsOEy6eD9/cNa1+WQviuzt9/lV9lf8XY1dLQlpyG0C5d2CR/haHOKWoNHHW48Lytob+eMFFyDWgwN1TxLOZTwGk6tvsMBZhcIeHZAg8BnUOXQdZI6YsecCDo3eoYSxOsC3aYIhCbdKBN//79D7tvsqtSkH0mQbKQgk5FifBrGbNrr/4xsGsN9FV7eFEUBr6beppwrAmkYMt9XvSFBy/a3MRj6hp4PHf9QCeLBR1jyuuZW7nLyrcrfaWsMWokLuc/OarVPimvlANlu+8vKqVEOwwhNS/efVxrbDfXt328PCxmy8QNKs2f8ZA+W55HvyhI2vYIezb3MFTj3M0uh0kFTSW+2T7c0lo82N8vxVdyts5wozWU5W43pMoekfncNSd0aHnffbVXYtm+3G0KHzX5/wChsp4l +sidebar_class_name: "post api-method" +info_path: en/release-management-api/code-push/api-reference/release-management-api-codepush +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Creates a deployment under the given app. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/create-code-push-staged-rollout-schedule.ParamsDetails.json b/docs/release-management-api/code-push/api-reference/create-code-push-staged-rollout-schedule.ParamsDetails.json new file mode 100644 index 00000000..4a74d2c1 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/create-code-push-staged-rollout-schedule.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"update_id","in":"path","description":"The uuidV4 identifier of the update.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/create-code-push-staged-rollout-schedule.RequestSchema.json b/docs/release-management-api/code-push/api-reference/create-code-push-staged-rollout-schedule.RequestSchema.json new file mode 100644 index 00000000..2c4f3a90 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/create-code-push-staged-rollout-schedule.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"location":{"type":"string","description":"The time zone in which the schedule dates are provided. It can be any TZ database time zone or UTC if the dates are given in Coordinated Universal Time."},"schedule":{"type":"array","items":{"type":"object","properties":{"percentage":{"type":"number","description":"A number greater than 0 and less than or equal to 100 representing the release percentage, where 100 indicates a full release."},"when":{"type":"string","description":"A date in ISO 8601 string format specifying when to run the schedule."}},"required":["percentage","when"]}}},"required":["location","schedule"]}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/create-code-push-staged-rollout-schedule.StatusCodes.json b/docs/release-management-api/code-push/api-reference/create-code-push-staged-rollout-schedule.StatusCodes.json new file mode 100644 index 00000000..49788888 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/create-code-push-staged-rollout-schedule.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Create staged rollout schedule","content":{"application/json":{"examples":{"201 - Create staged rollout schedule":{"value":{}}}}}},"400":{"description":"First step does not exceed current rollout percentage","content":{"application/json":{"examples":{"400 - Invalid time format":{"value":{"code":"ERR_INVALID_TIME_FORMAT","message":"when must be a valid datetime string; given value: 'gibberish'"}},"400 - First step does not exceed current rollout percentage":{"value":{"code":"ERR_INVALID_PARAMETER","message":"first schedule step (50.0%) must exceed the update's current rollout percentage (100.0%)"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/create-code-push-staged-rollout-schedule.api.mdx b/docs/release-management-api/code-push/api-reference/create-code-push-staged-rollout-schedule.api.mdx new file mode 100644 index 00000000..31a82538 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/create-code-push-staged-rollout-schedule.api.mdx @@ -0,0 +1,69 @@ +--- +id: create-code-push-staged-rollout-schedule +title: "Create staged rollout schedule" +description: "Creates a staged rollout schedule for the given CodePush update." +sidebar_label: "Create staged rollout schedule" +hide_title: true +hide_table_of_contents: true +api: eJytV+lu20YQfpUFgcKJYR12krZQc0C1lVaoL0iygcYxjBW5EjcmuezuUrYi6G8foI/YJ+k3u6SOSLbrov4h89iZ+eb6ZjgLImFCLXMrVRa0gkMtuBWGcWYsH4uIaZUkqrDMhLGIikSwkdLMxoKN5URk7FBF4rwwMSvyCIL1YC8wIiy0tNOgdTULrLoV0Ht1Pb/eC6DR4Dq4cGdNgEcqF5qT7W60sF7p7DsEPQ+gX9qHgZxrngortHEmMtxA1gO4kRFOSHIl5zbG9bp/AyAvChldvmYyEpmVIyk0UyPn0tIHLf4opBbAZHUh4BOspzxowaFpTtaM1TIbB3NySwuTq8zAIbw/aO7Tv21RfSiksBeqzAINSfI8T2ToYtL4Ykh8Foh7nubJwgCrsSc04tyEJwVdzN3fXvC62dwE9lFqAzErchYppD1Tlon7UEAnkqgBaaEbiQpxD3vPwwu7wNvNgEdGzMrUlVDK7SpIKIworJ1e76Z7etk+7h7dDLonnZuPZ72T9gAWU2EM2W4FdzHqLi2AeyhQp14vJc7p9on5qSxPp7/FdsZyOBRamngnKGMBTP/N+SdQn7d77ZPOoNNbwzzypqoecjZfvGnWm9+99K6UdpdVuGMeAcFe7DedcLDM7payu8h4YWOl5VcRPTdpVGRr8g/4fXHavhj8etbrfuocrbm8JryE+WoT5rnQqTQGNwwtKZ+P9RWwbip5APB5p3fS7fe7Z6c3R53T7jeoN9VU0N9s658uUOqMJ6wv9ARE0tFa6efBf1P2xzZFD9Ya6uu0fbyGvK/AiTFqn91R0dxp5fipRE+EJoz9WUVTr+xRfBt0p4ZfRGiJezUxtpUee6K84CYxbuNd159fVSaYzNhdLMPY1fuiKyI/ebRgsDIBPUd11rUs5Jnr9GzKBp/oEB9ys6oNA+licMikJ/GlFk8BkoaU0pHM8CJCTeOpNoj0AArqwdyTe8WapRdcaz6lQWJFap6Owzo9lGezIgXnbESizfwLNnYUTsMUDjbhX8RQEsbfwydkDCitYuh1pkWOMUMDCwkmN7VIBIVhaXoPMRVwm47LLKKcukE+KpKkOu78JQJ9OmNtF0kKX7d/xn78HozgT5b0zUwuQjmauoojSgZSXWRrKa0HVe35YXoVrE0RB+R6/u2ZRVWtpObalzGVuKJNIVfGpYFmfCtoeM40jdliC5g3/GyslexZW5m2xvWY3x4KnUDBjErqonc8b5SBqqU8g3gKrI3JQYOar5ZjJ2lM9qFgwrXkw7KBS1FPDiNeJGirILY2N61Gg+eyPpSIG2Iv1da28GiYK2roYXfSLhvDlajbMqq1qu+e+qL0y9WyanP5m5hW+08seLSl/s7bA5aJkHhDTylpBey2z7vosyQxOF7uUxV7+1RQ8Ikdekse6XgSW+eBZTUtu+pqvUGaVQUulqjrOUEeKeeKtCQT9Mr6PlnkwYGsLTZOSgOS6K1ODur7G57u7h4rdVtWrIuoSiLS8mF3l/2uCscsI7QKk5ZR67TYW85iLUbvdrbVAcJbi1RoGhAR9/XYpskHlI+p51qmCOYpAveuxP3dQXOJHDewit/LffwcQcUOs1yPhX23czNMeHa78/5y3/lHTfW2wd9/zj5ngyViFAWaGCwYEQ+Ejskwoj6KoS4ojftYIQ6aBz/UEa9bVE4BHgCPWDaFmzGfCJbKsXZiyDiFIhN3TvFQIDh0WGR1MvpoBLwSRLc2xg4tXAi2uCKhm2zAp7///ItdHrCTSpD9QoLkITERdTHUU97LqntyU15L8cog+z++XMo2suLeNvKEo4uA0RHErGSaq/Izg/qktfrF8RDZoHFjoipIzjzJ6GQ+p8foI03fSNdLOnGtEklD1yC5EU+MeMTjF72SNF+yf/lZs9XBijyyqWM2t24EuLwFlax+Vrk2LUmFgPr3hx5ObUBalvIbW8V8r5Joh6HI7aNnr1eY/vysT/v/sNxcUr8GaX5Hn2n4dViVC48jRfcMlMSzceE3I6+TGIw4bZ0vbx1flhfug3VbNNa5sAoN/ZJbW0VmM8/GSHZ13r96UGLB1/40JYem3j/DpmSn +sidebar_class_name: "post api-method" +info_path: en/release-management-api/code-push/api-reference/release-management-api-codepush +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Creates a staged rollout schedule for the given CodePush update. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/delete-code-push-staged-rollout-schedule.ParamsDetails.json b/docs/release-management-api/code-push/api-reference/delete-code-push-staged-rollout-schedule.ParamsDetails.json new file mode 100644 index 00000000..4a74d2c1 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/delete-code-push-staged-rollout-schedule.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"update_id","in":"path","description":"The uuidV4 identifier of the update.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/delete-code-push-staged-rollout-schedule.RequestSchema.json b/docs/release-management-api/code-push/api-reference/delete-code-push-staged-rollout-schedule.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/delete-code-push-staged-rollout-schedule.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/delete-code-push-staged-rollout-schedule.StatusCodes.json b/docs/release-management-api/code-push/api-reference/delete-code-push-staged-rollout-schedule.StatusCodes.json new file mode 100644 index 00000000..608369d1 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/delete-code-push-staged-rollout-schedule.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Delete staged rollout schedule","content":{"application/json":{"examples":{"204 - Delete staged rollout schedule":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Schedule already finished","content":{"application/json":{"examples":{"412 - No schedule exists for this update":{"value":{"code":"ERR_NOT_SCHEDULED","message":"No schedule exists for this update."}},"412 - Schedule already finished":{"value":{"code":"ERR_SCHEDULE_ALREADY_FINISHED","message":"Cannot delete: already finished."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/delete-code-push-staged-rollout-schedule.api.mdx b/docs/release-management-api/code-push/api-reference/delete-code-push-staged-rollout-schedule.api.mdx new file mode 100644 index 00000000..1702534a --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/delete-code-push-staged-rollout-schedule.api.mdx @@ -0,0 +1,69 @@ +--- +id: delete-code-push-staged-rollout-schedule +title: "Delete staged rollout schedule" +description: "Deletes the staged rollout schedule for the given CodePush update." +sidebar_label: "Delete staged rollout schedule" +hide_title: true +hide_table_of_contents: true +api: eJytVu1uIjcUfRVrpCptFBhgU1VCm12hwDaohER8RNpmI2SYC+MyjGdtDwlF/N0H2Efsk/TYM0AIsGmk5sfEw/jee86x77GXXkB6pERihIy9qleniAxpZkJi2vAJBUzJKJKpYXoUUpBGxMZSue8TMaeYXcqAblMdsjQJuKGid+ZpGqVKmIVXvV96Rk4Jme8fVg9nHjJqjL2+m6s9/CQTUtxWbwab+uucXYegkwHo5vVRIOGKzzBPaVcixgtiMwADEWCGsGQSbkKMdxn2gDxNRXB3zkRAsRFjQYrJsaO05aDoayoUAZNRKYETqs+4VwWhRWKraaNEPPFWlpYinchYgxC+V0rn9t8hXY9JinojGRugsZE8SSIxcpr4f2kbvvToic+SaFOAFdgrGTFvzqPUDlbu78w7L5X3gfVjnppQKvE3BW+DgXSAsRP/rCgyBVamRqcz6Ldr/d7VTaf5Z6OOGjPSGqBfFt/CfLcP85bUTGiNF4ZFE2/H+g5Y95McAXzb6Fw3u93mTXtQb7SbL1Dvp9lAL1f2oa/3LeORIh4s2FjEQodvplCugEJbbvuQnoQ2Om9HofPNe4xT+6Y36F5eNer91gs+r+csejk7IDhO50jhddFBrdVp1OqfB5+a7Wb36gWISx7H0kBQu6ure8mLG41/LZX2NW5CRhXziHVJzdHODaWkepu+yAt2hxMdYdZs9xqddq21Q6Qr4UwhrIE9ojJ7VNK5RI7efpPW6DKizstgUlXPz5TW/nJjYys/a+5C3tyFZ3ahHbzM/lIVIcFyyDX1O62Vr5Aa48KMxwifAYU/r/gWdyGBqfrzMhLMuRJ8mHPPQzNdxzyNoJgXGpPoqu/zRBSHAm6nqSjkQT/N0DCbhiEPexQmzI4Q65pu+1ibXJ8LXferq5yfDhtXRbE/aLE28BB7gNReydtaj8U0spKrBTOSpahbu22yEY8ijen5gbA2F7fobguLeCxdNWGsR3qdTCp2vZHK5SlsTjWrFHTO6s4rxfIemNPTlpRTu97rc1FGgc3y8fSUfZYpQMV2GwdMGBaSwuZ+z1moaHxxcmipoEAhkCPtI4SeiqGZRR+xwrqYKDED3za4XeS4f6qUtsjxgqp43pXxqCPFCTNcTchcnAyGEY+nJx/uyo6fTmj03ucfvsRf4t4WMdYtitiQ0IWJIvQKDhaY3CcaqtQqXdaGVUqV34rQa4rFTRWBMDdsAZohnxObiYlyYVgUK0VMjy7xkCCOnUxx0Rb9oQJZEqhbmOCcJifBASoCuW0NcPrn23d2V2HX60D2uw20DD0seiK1QXq77vnGePU03lni5dZG/p/7Ub7XDT0ZP4k4tjpQui5e5nZwn19m7GauPr/XHHMEdFcImjZymTmBilYr+/PXlJS9iT1se965RiC0HcOLxjzS9APOP3fyu9Av7D9eng4SXHd4vHD24+zUw3CKfn9+eVs9YHLe+RZo9r02GlFinkXu+bl1mI291hutRq+B6dYDdv1l6vwlH7gb6iFgu96xRmmfq7MjIctl5l7QfT0/+3Q0YuNv2Wyr0wOs8l/knftQ +sidebar_class_name: "delete api-method" +info_path: en/release-management-api/code-push/api-reference/release-management-api-codepush +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Deletes the staged rollout schedule for the given CodePush update. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/delete-deployment.ParamsDetails.json b/docs/release-management-api/code-push/api-reference/delete-deployment.ParamsDetails.json new file mode 100644 index 00000000..9f946177 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/delete-deployment.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the deployment.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/delete-deployment.RequestSchema.json b/docs/release-management-api/code-push/api-reference/delete-deployment.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/delete-deployment.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/delete-deployment.StatusCodes.json b/docs/release-management-api/code-push/api-reference/delete-deployment.StatusCodes.json new file mode 100644 index 00000000..0decdd49 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/delete-deployment.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Delete the deployment","content":{"application/json":{"examples":{"204 - Delete the deployment":{"value":{}}}}}},"400":{"description":"Bad request - The provided deployment id is invalid","content":{"application/json":{"examples":{"400 - Bad request - The provided deployment id is invalid":{"value":{"code":"ERR_INVALID_UUID","message":"the provided uuid is invalid"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/delete-deployment.api.mdx b/docs/release-management-api/code-push/api-reference/delete-deployment.api.mdx new file mode 100644 index 00000000..fecda8a8 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/delete-deployment.api.mdx @@ -0,0 +1,69 @@ +--- +id: delete-deployment +title: "Delete a deployment" +description: "Deletes a deployment." +sidebar_label: "Delete a deployment" +hide_title: true +hide_table_of_contents: true +api: eJydVu1u4kYUfZWRpSptBDiwWVVCm13RQlvUhI0IRGqzUTTYFzzFeNyZMQm1/LcP0Efsk/TM2HwFWCnND2fMzD333DNzjyf3QtKBEqkRMvHaXpdiMqQZZyGlsVwtKDENr+bJlBS3a/rhZlV3swILNAWZEmbltR9yz8g5Ae3hsXiseYbPNMbedrn28HPKFV8ARWkXkuAFyCIElrBMUm4ijPfpjSJiWSbC+0smQiCJqSDF5JQZTOwzVvRnJhSBrlEZgWAQ0YJ7bbBbpTaVNkokM6+wHBXpVCaatJ1vXVzaf8eEeZUHaQKZGDtCAE/TWAROJf8PbaNyj174Io03uKzOjgNhesnjDLzywv3VvMuLi0MaP/CQ2cpIG2BZOVIll9Ai3EGDNkxoJhJAOkHfQBJZAfx/0uyUgIShlbg3HD71B/ed6373aTzud0FlQVrzmZ00u6h2U3fBtiI0D0UYJzwzkVTiL3pzdU3Usxd/gvZ40BmPfvk87P/e26e9F7yl+e6Q5i2phdAaLxAtEW/n+g5cD0FOEL7tDW/6d3f9z4Onbm/Qf8X6EGZN/f2xY9YHS5XwmN2RWqLDekpJ9Tb6791BOg508qiMesNB53qP+Z2ES0ToVPZsz9yzkq5pK/Z2TlpLCl1bebXSN9qevz2n2s9FWDiPshxKv8lUjFX5hGsaD68LXyEe4/qCJ8hrw/xly7fk6mmmI3/ZBMCSK8EnVYFVaCnelGcxZPEiY1Ld9n2eisZEwGE0NYQ86mMlG2ZhGHDYszCRswXnVNSwRT5ujfXO/eoyV/a6cTIk+5VWa+OMiIekDlLedkYsocDqqlbMSJYhb+e2zwIexxrLKwden263s57VWCRT6bIJE9sVw1IqdrORyuHU2Y9Q6xZiWaWgc5l32Wo0D8icn19LObebOpXKFS3j0KJ8Oj9nv8kMpBI2FQk8wbCIFLXZB84iRdOrs2NbBQXqoQy0jxB6aURmEX/CDutGqsQC9Q5Q21XF+5vWxZY5XpAVz/smHl1AnDHD1YzM1dnTJObJ/OzjfdPVp1MKPvj845fkSzLaMsa+xTGbODdXhIaAm6HLfqKJyqzSTVho66L1fQN6zbG5mbLmzw1bocyIL4ktxEy5MGyKlSKhZwc8IYjjvhRJwyb9qgIlCNStz2Cl5CQ4UooAts2Bmv79+x9232I360D2sw20FXrY9FRqA3i779XBOHY1eL2x+dYhTl4lqkNr6MX4acxxZpHOtWNeNe+Dt9O8iGjjg4BOiEDJTuZl16q4KOzP+Eope+143Pan6/BQaDuGOUx5rOkrTL8dVneF79gbLhhH61h3ZLJyduE8zsNwjv50t5viEauqFrUsy4lOEFBqdkIO3NVawcbsur3r3qiH5bZZ941g7oygGri72DFG+02+pmefRe1ESJ6XNlMUm/Xl1MmIjRFVxdsi4Gn/AVxhk7o= +sidebar_class_name: "delete api-method" +info_path: en/release-management-api/code-push/api-reference/release-management-api-codepush +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Deletes a deployment. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/delete-update.ParamsDetails.json b/docs/release-management-api/code-push/api-reference/delete-update.ParamsDetails.json new file mode 100644 index 00000000..568698f1 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/delete-update.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the update.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/delete-update.RequestSchema.json b/docs/release-management-api/code-push/api-reference/delete-update.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/delete-update.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/delete-update.StatusCodes.json b/docs/release-management-api/code-push/api-reference/delete-update.StatusCodes.json new file mode 100644 index 00000000..0e44d062 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/delete-update.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Delete the update","content":{"application/json":{"examples":{"204 - Delete the update":{"value":{}}}}}},"400":{"description":"Bad request - The provided update id is invalid","content":{"application/json":{"examples":{"400 - Bad request - The provided update id is invalid":{"value":{"code":"ERR_INVALID_UUID","message":"The given update id is not a uuid: invalid."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/delete-update.api.mdx b/docs/release-management-api/code-push/api-reference/delete-update.api.mdx new file mode 100644 index 00000000..8b709773 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/delete-update.api.mdx @@ -0,0 +1,69 @@ +--- +id: delete-update +title: "Delete an update" +description: "Deletes an update." +sidebar_label: "Delete an update" +hide_title: true +hide_table_of_contents: true +api: eJyVVu1uIjcUfRXLUpU2Ckxgs6qENruihbaoCRsRiNRmo8gwF8ZlsKe2h4Si+dsH6CP2SXrsGWBZyKrJj4kH349zz/U94zWPyU6MzJzUird4h1JyZJlQLM9i4ajOz7jOyAhv0Iu3JqOwi01Lk9xIt+Kt+zV3ek4Ic/9QPJxxJ2YWa16aWo6fMmHEAt7GBnOFF0SUMeJInz4TLsF6H9MwIZbnMr67YDIm5eRUkmF6ypzf2KI09GcuDQGiMzkB2CShheAtoFplPo11RqoZLzw2QzbTygIV9pvnF/7fMSY+y4EUE60cAHhjkWWpnARWoj+s91hzehaLLN3GZDV2GARbS5HmflGEvzN+cX5+mP4HETNfEVmHOJ6CzOgl6o+rSOCCScukQrhA4CvAISOCvjbFZ9CRLPaUdgeDx17/rn3V6zyORr0OYCzIWjGjqm8zuSS1H05px0RoaGsTus53XDQOuRgpkbtEG/kXvbrQBkrb83+hilG/PRr+8nHQ+727X8We8w7mm0OYN2QW0lq8MBxT+Xqsb4D1MMgLgG+6g+ve7W3vY/+x0+33vkB9GGYD/e2x09YDSqNEym7JLDFcXWO0eR38t+FMHQ/04skZdgf99tUe8lsNgUgwqOwJmdmT0WFmK/R+T3sVisNk8bNSMlo8Ks+YjdYyLoIs+fylzOQmhcV6LCyNBldFZOCLdW0hFHIukCZaNiMPrJblNomWDQRYCiPFuCquci2Jm4o8BSU8cS6zrSgSmayPJcTFUl3qo/JVomE+DEMc9iRdElQhiBSF8/+w09Lb8GvIXCnqVsSQ7FdabfQyIRGTOUh50x4yRRPPqVkxp1mOvO2bHpuINLUwr4R3c7JDV7nnV6qpDtmkS73FoKSKXW+pCnFq7EewdQOyPFPgucy7bNYbB2BOT6+0nvuGTrUJRes09lE+nJ6y33QOUIpNpYI4OJaQoRZ7J1hiaHp5cqxVYKAW64mN4ELP9cQt0g/osK1nRi5Qbx+1XVa4v2me75DjBVnxvGvg0UGIE+aEmZG7PHkcp0LNT97fNUJ9NqPJu0i8/6Q+qeEOMfqWpmxMmKnMEIYBUokJ+4nGJvdMN6CkzfPm93XwNUdzc+O1Xzi2QpmJWBJbyJkJbmiKp0LRUwg8JpATPhSq7pN+lYEyCNitzaCiFCg4UopEbJ8DNf379z/srsmuN47sZ+/oK+RoeqatQ3jf9+pgHFwDvuzqeicNx+8M1XF19OyiLBU4rUgUBnFdjew9r0YW1i18XnD+EwDxG+tyVk1aFP5nfKKMv1887KYyzHUsrV9DDqYitfQViN8OqsvBd+x/3iaO4t/MoFoFgQiKxrGcYyLDNaZ4gFU1lB5hudGeTChzn7kcaKkf/q20dbpX3WEX5n4890d/Hka/WoQL1zFE+2O9geefxdkLLut1KSxFsbUvt1702EpPVbwvAir2HwEzguQ= +sidebar_class_name: "delete api-method" +info_path: en/release-management-api/code-push/api-reference/release-management-api-codepush +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Deletes an update. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-deployment.ParamsDetails.json b/docs/release-management-api/code-push/api-reference/get-code-push-deployment.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-deployment.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-deployment.RequestSchema.json b/docs/release-management-api/code-push/api-reference/get-code-push-deployment.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-deployment.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-deployment.StatusCodes.json b/docs/release-management-api/code-push/api-reference/get-code-push-deployment.StatusCodes.json new file mode 100644 index 00000000..8b9e3ad9 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-deployment.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Get the deployment","content":{"application/json":{"examples":{"200 - when user can create connected apps":{"value":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"Example deployment","created_at":"2025-02-06T09:26:01.000Z","updated_at":"2025-02-06T09:26:01.000Z","number_of_updates":13,"key":"random_generated_base64_key","package":{"app_version":"1.3.0","id":"123e4567-e89b-12d3-a456-426614174000","label":"123e4567-e89b-12d3-a456-426614174000","mandatory":true,"release_method":"Upload","release_time":"2025-02-06T09:26:01.000Z","rollout":100},"update":{"app_version":"1.3.0","id":"123e4567-e89b-12d3-a456-426614174000","label":"123e4567-e89b-12d3-a456-426614174000","mandatory":true,"release_method":"Upload","release_time":"2025-02-06T09:26:01.000Z","rollout":100}}},"200 - when there are no packages for the deployment":{"value":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"Example deployment","created_at":"2025-02-06T09:26:01.000Z","updated_at":"2025-02-06T09:26:01.000Z","number_of_updates":13,"key":"random_generated_base64_key"}},"200 - when user cannot create connected app":{"value":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"Example deployment","created_at":"2025-02-06T09:26:01.000Z","updated_at":"2025-02-06T09:26:01.000Z","number_of_updates":13,"package":{"app_version":"1.3.0","id":"123e4567-e89b-12d3-a456-426614174000","label":"123e4567-e89b-12d3-a456-426614174000","mandatory":true,"release_method":"Upload","release_time":"2025-02-06T09:26:01.000Z","rollout":100},"update":{"app_version":"1.3.0","id":"123e4567-e89b-12d3-a456-426614174000","label":"123e4567-e89b-12d3-a456-426614174000","mandatory":true,"release_method":"Upload","release_time":"2025-02-06T09:26:01.000Z","rollout":100}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"examples":{"400 - Bad request":{"value":{"code":"ERR_INVALID_UUID","message":"The given deployment id is not a uuid: invalid."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Deployment not found","content":{"application/json":{"examples":{"404 - Deployment not found":{"value":{"code":"ERR_NOT_FOUND","message":"cannot find deployment for the provided uuid"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-deployment.api.mdx b/docs/release-management-api/code-push/api-reference/get-code-push-deployment.api.mdx new file mode 100644 index 00000000..c284747e --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-deployment.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-code-push-deployment +title: "Get a deployment" +description: "Gets a deployment with the given identifier." +sidebar_label: "Get a deployment" +hide_title: true +hide_table_of_contents: true +api: eJztWOtuGkcUfpXRSpVby1wWY7tBcSK3Ji6qgy0MlhrHQsPugZ16mdnMzOJQxN8+QB+xT9JzZhcWDEThZ6JaMl525pz5vnMfz7wQTKBFYoWSXsO7AmsYZyEksZqOQVr2LGzEbARsJCYgmQjxpRgK0GXvyDMQpFrYqdd4mHlWPQHqeHicPx55lo8MPnuXS03Gw9cqAc3prFaYnfarCuE2NVGxD9UmXPMxWNDGKZb4BXeLEJcEoUy4jfBZw6dUaEBNVqeAaIIIxtxrIJRpQhLGaiFH3pwAaTCJkgYMrdeqVfqzwd0RDVehBEpaesLdPEliETj0lT8Nicw8+MzHSbxUykrsOUIrpQY0C7hkgQZugaEWCYGFkKESt3nC4xToQZAh/Nox1E9Oz0rw86tBya+FxyWO30v12umpX/fP6lUEfLQwRDM79AVQd1LY54gVodROStVaqXrarb5q1E4bVb+MKj7gvjQJv2qfTMcD0H017GcSiNo/PvKeAJ3taS5DNe6PQJI7UduAGzit92mV3Bc88RHkNutP0I+Zhf3ycZl47MM55gOIv377GJFxq/R0ERQaYkBwfYynSNG5PTQaD71ixQpn1S/YQqs4VikazK9W5wsTfqf05khwJZIxITQwjr9Ssdyxhg2Vfpkq33VMvzDKIr2lslsz/Fs2xv/J+w3Ty36OvPq2/vYLDxm1TDB7Nra6i/xV8dX4DrCDU8x2Ov1W+/7iunXZ7/Val8QXjHGh5HWX88PKZCFCJgyjHOIsTUXYYEKiVhGWvYKHv8mjJ3mK9tLiLwj3JeIjkTX5HUx67Yte97ebTutDc53JmnAB83gT5i3osTAUXUhaiv2xHiPWTSU7AN82O+9bd3etm3b/stluvUC9qaaAXt+EXgxjzj1Dlcq90dcR/VY9Owi0b7r9dze99jrwvMgOhQxXQ2fRfxKtJjiRhi5+lpxOtkV/C7FryWN2BxqznjW1Vno/UicuD7Yr2pkR3WanfXG9RupOUcLjZMqe3YStlRtSc/TLYjCCbBbGWbfhVQr2pjIT4dxN3wQgm5FTTYVoRj2r17meV/ICUsKag4eSWGVSqxCyUoLjdmXio4IJ14IPcna5aGa5IU9j6h+RtYlpVCo8EeWBwHHaQFkoFF03LuV3hoaRGoZ6iouDG8vBJfVjcWW4c2/dyfnFYTm242G/u0HSDfsR8BD0xpG3F12GHZeMqqfMKmrK7OK2hX05jk3RSxfp6tzqGrmQQ+VOEzamHZ3MVOz90lROT4kt7iZkqWWfmNTK/gaYw8NrpZ7Io4vIVHFIWt4eHrI/VOruAi6IhWU0UTXYa84iDcPzg22uQguUQhWYCorA53Jkx/Fb9LApJ1qMkW8buZ3nuH+oVQvk+AVPxc97Hz8uUcUBs1xjKJ0f9Acxl08Hb+59x88kELyu8Dcf5UfZLRCj3+KYDdzwoSGgUYJh2XgHA52SpX1jGbajszLa6wmdm+JoaCNu2RRpRnwCbCxGboAip5ApJDw7xQNA49BmkGU69IsWyJSgdUsjTG1wJthCRaBuOgM5/fv3P+y+xt4vBNkVCRJDD52eKGNRPfk9D4yNq+5Lr86K2rDvvTgPZAufbSWJOcYxTR6UorM8oR+8lYRGiQbWL8yOSFF3ffBmWSbreD6n19h1aWp4eCxy1mV9KAw9Y7UY8tjAFwj82Mkvyz+xXfgW2SenrjS4YuZ5i/GY6usj7srTkU7PFi6CABK7IrJRRintl1XtqtnFvZSV6xmfXR3zB/fvhG1w1rN5gc2N6Ec7RGazrJ7M58v92dJOiWXFyZkTAyxe/wF9dYLW +sidebar_class_name: "get api-method" +info_path: en/release-management-api/code-push/api-reference/release-management-api-codepush +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gets a deployment with the given identifier. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-metrics.ParamsDetails.json b/docs/release-management-api/code-push/api-reference/get-code-push-metrics.ParamsDetails.json new file mode 100644 index 00000000..84471327 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-metrics.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspace_slug","in":"query","required":true,"description":"The unique identifier of the workspace.","schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-metrics.RequestSchema.json b/docs/release-management-api/code-push/api-reference/get-code-push-metrics.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-metrics.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-metrics.StatusCodes.json b/docs/release-management-api/code-push/api-reference/get-code-push-metrics.StatusCodes.json new file mode 100644 index 00000000..51b0ca74 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-metrics.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Get metrics","content":{"application/json":{"examples":{"200 - Get metrics":{"value":{"data_transfer":0.28,"data_transfer_limit":125000,"storage":12.4,"storage_limit":25,"monthly_active_users":5000,"monthly_active_users_limit":100000,"cycle":{"start":"2025-10-06","end":"2025-11-06"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-metrics.api.mdx b/docs/release-management-api/code-push/api-reference/get-code-push-metrics.api.mdx new file mode 100644 index 00000000..bb33b878 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-metrics.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-code-push-metrics +title: "Get workspace level metrics" +description: "Gets storage and MAU metrics of CodePush for the given Workspace." +sidebar_label: "Get workspace level metrics" +hide_title: true +hide_table_of_contents: true +api: eJytVuFuIjcQfhXLUpU2Anbhjl6FLndCDU1REy4iJFWbi5DZHVgXr71neyEU8fceoI/YJ+nYu0sgkKqRmh9k1+uZ+eabmc9e0xhMpHlmuZK0Qy/AGmKs0mwGhMmYXHVvSQpW88gQNSU/qhiuc5OQqdLEJkBmfAGS/Kr03GQsggatUZWBZs5fPy48VkZXhR/cYiDKNbcr2rlfU6vmgLHvHzYPNWrZzOAzrfbiUsY0Qwigjd8u8QX9LquQYyPyGfrkDv+XHPQKXzR8ybkGBGB1DrVnWY4QeC45biY8Bmn5lIN26bmMlru5mCiBlNEOolxlLqxBWHJGNw6rBpMpacC4760wdP8O6KzYQ2eRkhajuW0sywSPPEvBH8btXVN4ZGkmtt5Ineya4+KCiRx8EGbZ2GomzRQ07YSN1g+1/cWx4CnHSM1WOwxDzKMoqVtovN2+Vrta7RpNEVwiVmMWWSzpODee78L62LdthDD0e6JVJDw4Y5nGdUyh1a43w3r4PaYOMt4uNd3Spvir0bdh85C3W8lymyjN/8QSvoo4dIfE7dnvMhdhK6L/3nA4vh10b0c/fxr2f++dY4wUjPEM7Qd/gvnmEOY16JQbgy8E24i/HusbxHro5AXA173hVf/mpv9pMD7vDfrPUB+6qaC3j3VmH1FqyQS5Ab3A5u9prfTr4Ld9jx539EIK/cGoNxx0L/eQ3yjs8QSniiwxMllq5QesRO++Kdc8M7DUiYFN8CVId7TExS20IdcCP64nzMDt8HITaBCAz/WUSYyVovtg0QocoHqGghQsmuhgwTRnkzKp0rQgbMpy4Vo5sTYznSBgGW9MOAY20OCKHpOVAg1xbgj6IUtuEy8rXklQUzZeOioBvPGrPnIpg1ulwWC/wKoStgRYDPog5HV3RCREjku9IlYRnE3Sve6TiAnh2CnVsupoX03qeOVyqnw0bt3c0mFBFbnaUuX91LeS75hCnou4i1ajeQDm9PRSqbkrZHU6KBE7Lx9PT8lvKkdQkkw5nirckgQ0dMh7RhIN07OTY6VCBuqxikyAJvDYSGwqPmKFTSPTPMV8B5jbWYn7m1b4hBxfMCr+3jXx5xxdnBBUJeygs5PxRDA5P/lw1/T5mQyi9wH78Fl+lqMnxFg3IcgEcJYyDTgEEBOcrJ9gonPHdNNYgmr2roF8zbG4uQZMmFmywjQTtgCS8pn2ZlgUR4WEpXc8ASTHbQbZcEH/lYHCCbJbn+V4UnkKjqTC0beLgTn9/fUvctciV5UhuXCGLkOKRc+Useje1b1sDH/gb488ImABYufI2ivw+kkd/peLQtnoFh5tkAmGfY4Q/Qivyzm/p+nTPSBB8G5pXcy3FpuNWy6OfDf9MTdujlEspkyY56f+Lvpvh+X94Dvy3+8CR+HOcUSPXEZK8aPUDXslMP6OU6tG2SEurLtRBJndsTpQXudlK4QXvRHudRO9rxZzrxblg79YlZ/katf3nhJUCbjfTe0Fk/W60CLku9pffHrRYqtWxW5H1QMK3z/Z148s +sidebar_class_name: "get api-method" +info_path: en/release-management-api/code-push/api-reference/release-management-api-codepush +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gets storage and MAU metrics of CodePush for the given Workspace. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-staged-rollout-schedule.ParamsDetails.json b/docs/release-management-api/code-push/api-reference/get-code-push-staged-rollout-schedule.ParamsDetails.json new file mode 100644 index 00000000..4a74d2c1 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-staged-rollout-schedule.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"update_id","in":"path","description":"The uuidV4 identifier of the update.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-staged-rollout-schedule.RequestSchema.json b/docs/release-management-api/code-push/api-reference/get-code-push-staged-rollout-schedule.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-staged-rollout-schedule.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-staged-rollout-schedule.StatusCodes.json b/docs/release-management-api/code-push/api-reference/get-code-push-staged-rollout-schedule.StatusCodes.json new file mode 100644 index 00000000..931e69cc --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-staged-rollout-schedule.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Get staged rollout schedule","content":{"application/json":{"examples":{"200 - Get staged rollout schedule":{"value":{"schedule":[{"id":"ab1de5df-7b10-49a6-91e6-46b08395ce71","has_run":false,"rollout_percentage":50,"when":"2025-02-12T09:26:01.000Z","last_run_at":null,"status":null}],"setup_location":"UTC","paused":false,"last_paused_at":null,"failure_reason":null}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"No schedule found for this update","content":{"application/json":{"examples":{"404 - No schedule found for this update":{"value":{"code":"ERR_NOT_FOUND","message":"No staged rollout schedule found for this update."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-staged-rollout-schedule.api.mdx b/docs/release-management-api/code-push/api-reference/get-code-push-staged-rollout-schedule.api.mdx new file mode 100644 index 00000000..9fcd671c --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-staged-rollout-schedule.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-code-push-staged-rollout-schedule +title: "Get staged rollout schedule" +description: "Gets the staged rollout schedule for the given CodePush update." +sidebar_label: "Get staged rollout schedule" +hide_title: true +hide_table_of_contents: true +api: eJytVu1u2zYUfRVCwJAtiCzZTdLF6AeCxk2NpU7gjwBrGhi0dB1xkUWVpJxkRv7uAfaIe5IdUvLXbHcLsPxwKIk8955zeQ8582LSkRK5ETLzmt45Gc1MQkwbfkcxUzJNZWGYjhKKi5TYWCr3/U5MKWMfZExXhU5YkcfcUM078DRFhRLmyWvezDwj7wmwN7fPtwceEDXG3sDN1R5eyZwUt6HbcRl8Dthz4btl9F4VHOg5V3xChpR2+BkesLCMPhQxZghLI+cmwXidWx9pF4WIrw+ZiCkzYixIMTl2fJYEFH0rhCIkZFRBIIToE+41weYpt9G0USK7854tJ0U6l5kGG3xvhKH9t6HoLjERLJKZQSp2Gc/zVEROjeA3bdfOPHrkkzxdoDOffQ8Ok6Y8Ldxg+RIyCasuH9VjOorH/utRPfQPT/ixf1KnY//weBT+/OrkKKLXdWSUcD1UBaKPeapBv4oyRKUiZIrIXvMoPPAeEltZZNU48sOGX2/0w5Nm47gZ1mthGH4BUsq1sVBDDn5ZkabQ0nBT6PLJyqfJFPkwlSVtwA36H1yVC20LUKXggMp3K1hjLtJC0VARd2o5TPd34B2G9c1KDDJemEQq8TvFL5MecJB+bf2q1hE2LfBb3e5w0Dkd9D9ddttfWmeIMSGtnWLrwZdpvtpM84rURGiNB4ZdKl6e6yvkugmyI+GrVvdzu9drX3aGZ61O+x9Zb8IsUz/cTL0jV42iyOLKLoSu+uulVA5B5d9Bd1DrXPaHHy8HnXVKFm6nt21Bry0oH21r7zbYqIynrEdqCjtpKSXVy2geucbeDrSDWrvTb3U7pxdrzHoSzpjAmtgDIrMHJZ1LVdnbb9L6wB0Z12JwyKYXlCR1MFt46HNQ6uNX+vgrdqVdbqX3FioFwGzENQ26F8+BohSdSP6EZ1g+QQrBtBHYpP0cjh5MrbtMuRJ8VBGvlpaijnmRQi4vMSbXzSDguaiNBKxWU03IrWZeZsMsDAMOexAmKQ8va9ll5W6XJ1LPvXWRq3NpYekI9gs9zU+PhHhMaiPk1WmfZRRZvdUTM5LBkNjpVZtFPE01plen0bzRS0+z2otsLF00Yawje91SKvZ5IZXD8RfnqVUKOpdxp41afSOZ/f0LKe9tsecnskxji/J+f5/9KgsklbGxwH4WhiWkqMnecJYoGr/d21YqKODHMtIBltBjLTGT9D0qrGu5EhPw7YDb2yrvHxrhMnM8ICp+r+v4OQPEHjNcYZe93RuOUp7d7727rjt+OqfoTcDffc2+Zv1lxqhbmrIRwWJyRWgU9CYM5yONVGGVrmvDcMy8rkGvexQXpg/C3LAn0Ez4lNhE3Cm3DEWxUmT04IBHBHHsZMpqNuh3FShBoK5/h0sCOQm2UBHAtjHA6a8//mTXDfZ5vpCd24WWoYei51IbwNu6Vxvj+1eBtfrOlgbyP9zJql1u6NEEecqxyZGf699ZZQQ31R3KbuPm6nVqlxegrxIQtCtnpQconL729beClL393S673flFLLQdL4/1nYR/7FZXsJ/Yf7yzbSU47+3syRmPc1EPw3t0+uqd8fkWk6uet4mW30+jiHKzsnLDxq23LFz1vNXHXNv667Zy72ylGrgr8bas1i1jnqL9fT7YsWQ2K00Los/nl592rljYWjnbinQLh/wbM9gd1Q== +sidebar_class_name: "get api-method" +info_path: en/release-management-api/code-push/api-reference/release-management-api-codepush +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gets the staged rollout schedule for the given CodePush update. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-update-status.ParamsDetails.json b/docs/release-management-api/code-push/api-reference/get-code-push-update-status.ParamsDetails.json new file mode 100644 index 00000000..568698f1 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-update-status.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the update.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-update-status.RequestSchema.json b/docs/release-management-api/code-push/api-reference/get-code-push-update-status.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-update-status.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-update-status.StatusCodes.json b/docs/release-management-api/code-push/api-reference/get-code-push-update-status.StatusCodes.json new file mode 100644 index 00000000..0121b36a --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-update-status.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Get the update status","content":{"application/json":{"examples":{"200 - Get the update status":{"value":{"update_id":"9a35afac-81a4-488d-a986-3c13015d70a0","status":"uploaded","status_reason":""}}}}}},"400":{"description":"Bad request","content":{"application/json":{"examples":{"400 - Bad request":{"value":{"code":"ERR_INVALID_UUID","message":"The given update id is not a uuid: invalid."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Update not found","content":{"application/json":{"examples":{"404 - Update not found":{"value":{"code":"ERR_NOT_FOUND","message":"cannot find update for the provided uuid"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-update-status.api.mdx b/docs/release-management-api/code-push/api-reference/get-code-push-update-status.api.mdx new file mode 100644 index 00000000..98be66a9 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-update-status.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-code-push-update-status +title: "Get the status of an update" +description: "Gets the status of an update." +sidebar_label: "Get the status of an update" +hide_title: true +hide_table_of_contents: true +api: eJyVVu1uIjcUfRVrpCptFBggZDeLNruiDZuiJgTxEanNRsjMXBiXwZ61PSQs4m8foI/YJ+m9ngFCgLTJDzIz9r33nPtx7IUXggm0SKxQ0qt5V2ANsxEwY7lNDVMjxiVLk5BbKHonnoEg1cLOvdr9wrNqAmh0/7B8OPEsHxt89vpur/Hwk0pAc3LcDDPXv6gQ2qmJsj1dFwKdJlzzKVjQxrmV+IL7RYhLgkAl3Eb4vI20hyDTVIR3VSZCkFaMBGjCS+g3gDV8S4UGBGB1CkggiGDKvRqinycUxlgt5NhbEgcNJlHSIHpcr5RK9G8nP88C5FnCMIGSFkGQAU+SWASOt/+nIauFB098msRrv6zA9jvC5RmPU6CHbGUgKHcf+OkZH/GgcF7m1UL1/Dws8A/n7wqnQfm0VD4L35d4iaqTe0HbWPEQwvW3gQbusHjIlP5OvOo+fj/zkFHKwNi3sao6Vs/Nn3MJsPDovdHpDJqtu/p183LQ7zcvMcQUjOFjyAs6FjNYtRuWlQnDpLKMu0rXmJDoUYTFZxzKuxz6kqc2Ulp8dwl4E4kyktiyP8Ci36r3e7/edpp/NLZZbBlvYJ7uwmyDngpj8IVh/4q3Yz1FrLtODgBuNzo3zW63edsaXDZazReod91soFf3ZDgrEJVmpFL5ZuRVyvJLHweAt257gy+3/dY24IBLZylkuGqXkdJuohKtZqgIoeuZNY+zfd3eRMxa8ph1Qc9QPRpaK/02Mmeu7/c7OjgBvUanVb/eItRVqIARKhF7xMjsUSsnSjl6WlMkBGOwTjBREGuenzE3/kKES3+tRcZhyLQ01TFuXAy5gX7neulriFEIoDDlEuNOMZQ/q/gErpCgMPuzMjqYcS34MCeYm2bJG/E0xrR4kbWJqfk+T0RxKFBBDRSF2qvRGRpGbhj6YY/CRtkJQ0oMbpYfNgdL1311kfPjZa3UGOw3mK8OhQhQ4PROyHa9xyQElFc9Z1axFOPW200W8Dim7OSny2pKXWU9yrGQI+WiCRvTjk6WKnazTpXzU2CrU4wyhXnO4s4qxfIOmOPja6UmVNRVc6o4JC+fj4/Z7ypFUDLrYWFZBBpq7CNnkYbRxdG+UmEGCqEKjI8m8FSM7DT+jBU2xUSLKfJtIbeLHPcPldIGOb5gVPy9K+PPJbo4YpZr7KaLo8Ew5nJy9Omu7PiZBIKPPv/0VX6VvQ1irFscsyGgPiQacCBwwFAtvsBQp5TpsrGsUqq8L2K+JljcVAMS5pbNkWbEZ8CmYqydGRaFUiHh0TkeAiaHNoMsUtBXM5A5wewWxjjd4FKwh4pA3xQDOf3z19/srsJuVobsigyJoYdFT5Sx6J7qnjfGazeglwVebJTiP29OeRNbeLJ+EnPsYQzvxnORz/N9fuRTl9bE5uymq1Sk6ES99xbZKOt4uaTPeNJquos9bIbWjX0oDD2jYox4bOAV2D928gvST+x/3qj2ElmNqJw7/XCi5+HjBAfWXeWWD7grn1lCmC3UgwAS+8xkR25JG9bqd9Xo4V4a3W1ZmDhZyB/czXQfnO2RX2Gj3+XJAZPFIhMdzPZqf7Z00GItSzlzYoAK9y+zUeBD +sidebar_class_name: "get api-method" +info_path: en/release-management-api/code-push/api-reference/release-management-api-codepush +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gets the status of an update. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-update-upload-url.ParamsDetails.json b/docs/release-management-api/code-push/api-reference/get-code-push-update-upload-url.ParamsDetails.json new file mode 100644 index 00000000..31bc35af --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-update-upload-url.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"deployment_id","in":"query","required":true,"description":"The uuidV4 identifier of the deployment under which the update will be uploaded.","schema":{"type":"string"}},{"name":"id","in":"path","description":"A uuidV4 identifier for the update.","required":true,"schema":{"type":"string"}},{"name":"app_version","in":"query","required":true,"description":"The app version (e.g., 1.0.0) that this update targets.","schema":{"type":"string"}},{"name":"description","in":"query","required":false,"description":"A description of the update to display in the release history.","schema":{"type":"string"}},{"name":"disabled","in":"query","required":false,"description":"If set to true, disables the update immediately after upload.","schema":{"type":"string"}},{"name":"file_name","in":"query","required":true,"description":"The name of the uploaded file (e.g., main.jsbundle).","schema":{"type":"string"}},{"name":"file_size_bytes","in":"query","required":true,"description":"The size of the file in bytes, used to validate the upload.","schema":{"type":"string"}},{"name":"mandatory","in":"query","required":false,"description":"If set to true, marks the update as mandatory for all users.","schema":{"type":"string"}},{"name":"rollout","in":"query","required":false,"description":"The percentage (0–100) of users to gradually roll the update out to.","schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-update-upload-url.RequestSchema.json b/docs/release-management-api/code-push/api-reference/get-code-push-update-upload-url.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-update-upload-url.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-update-upload-url.StatusCodes.json b/docs/release-management-api/code-push/api-reference/get-code-push-update-upload-url.StatusCodes.json new file mode 100644 index 00000000..bf1a485d --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-update-upload-url.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Get upload url","content":{"application/json":{"examples":{"200 - Get upload url":{"value":{"headers":{"Content-Type":"application/vnd.android.package-archive"},"method":"PUT","url":"https://bitrise-storage.com/apps/io.bitrise.test{deployments123e4567-e89b-12d3-a456-426614174000/updates/9a35afac-81a4-488d-a986-3c13015d70a0/New file?signed-url-data"}}}}}},"400":{"description":"Bad request - The app version is missing","content":{"application/json":{"examples":{"400 - when app_version parameter is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: app_version"}},"400 - when file_name parameter is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: file_name"}},"400 - when file_size_bytes parameter is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: file_size_bytes"}},"400 - Bad request - The provided update id is invalid":{"value":{"code":"ERR_INVALID_UUID","message":"the provided uuid is invalid"}},"400 - Bad request - The app version is missing":{"value":{"code":"ERR_VALIDATION","message":"app_version is required"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Not found - The deployment is not found","content":{"application/json":{"examples":{"404 - Not found - The deployment is not found":{"value":{"code":"ERR_NOT_FOUND","message":"cannot find deployment for the provided uuid"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-update-upload-url.api.mdx b/docs/release-management-api/code-push/api-reference/get-code-push-update-upload-url.api.mdx new file mode 100644 index 00000000..642c4890 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-update-upload-url.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-code-push-update-upload-url +title: "Generate an upload url for an update" +description: "Generates a signed upload url valid for 1 hour for an update to be uploaded to Bitrise." +sidebar_label: "Generate an upload url for an update" +hide_title: true +hide_table_of_contents: true +api: eJzNWetu20YWfpUBgUWawKREWU4coWmgNm5W2EQ2ZMlAmxrCiByJU1MkOzOUoxUE7K99gO0b9kn6zZDixbqs5aTYzQ9ZIme+851zZs4tK8tn0hM8UTyOrI71nkVMUMUkoUTyWcR8kiZhTPFHhGRBQ+6TaSyIS4I4FeYrjbDExx6iYjJh+XpsxM/vuRJcMsc6sSTzUsHV0up8WlkqvmMQ9+l2fXtiKTqT+G6NDIq08ChONAtQ6vmGlPoh9tlVKoNszciIGIkQuAkVdM4UE9IgR/iBLT7DkuWcRWrMfaziWrnfUiaW+CHYbykXDNBKpOzkgQmGAXRIuX/TJtwHAJ9yJkg8JQovSlySRj6e3wfcC8yr3Aj3PAyrZjC6ewGbU6sDxZeJpidhlmhmrdcnBeOSZkJVYD1k1d3BSVu/lOzs0OwxgmmSjBcwn5ZztKGwmeSbyTfMmTknxHWaTvM5iFGFDy6L00HFjCn5WHtUZe2lNaWh3OLVJZXfG8eVR9TnMgnpkvDIvBAsZFQyAqYqFstH0+OSTkJ24Gzt5NabEsmUpmEsSnIYWeXI53Pmc3wLl4ROcbLzs/RYalMesrH5frQ79a7SYvk91ngb584pj5xf5QSHP2TPj2Ik+T/ZeLLUN/xoXnrvhpehA+cZqBOSyizUmNhkXFxwfyy9OY2wMzZcvsSZcyruap6kkhTYWaxEbABh8ehbIOIwjFN1JDFtMkRQD5GCzuC75h//+t1t4lLChEa85jwT1E9BaEm0kCptCMSCwxRvNQmZxJGEP/G+1WzqPw+ziaqkD+B5caRASq9E5Ai5Z4J841epl68s9pnOk7AAJDZ5gIDn8HPK9JeA4XQKs/aHDNYeZiSr0IvId+ACEXPfSah3B3vYVHgBXzBrfWIhcwSxzjFXoyH4GRlWoFQiO43GJMtetg4M2Od48bwBbNngsZO/c3AG1arMCtJtnbL22ctXNjt/PbHdln9qU/y2262XL922+6rdbDYbmZ1l4zU9PaNT6tnnLm3b7fNz36avz1/ap5572nTP/FdN2mz02b0582+zfGyDo43tFE7Q/06s9i7Tfw+L6VMCejDjw1CNqDznUmpXHuWUtnHKfcAiUkkbpMjBVeCqrzykb5C6GAzGV91B9+PF8GIw/ti7vu7131vaC1LCwCb3AamCQvIUZ5D0czZP1FI/5ZG58Z0qESs3x4ZjEQn/twzLgLyLXxkX/w9YVoJ0yXX7LCUiXnDfFIdZyvI1Zg61j3Gvf9P90Hs3Ho1672pkVQ0xrYMdorHnSO+Rb6R3h73Lfk169SADpAit5fVyt6/XKKIpIoeAufxjr5AL9rX9e/iO+t3R8O+Xg97PF3V71TaXNE+3aV4xYYwC1VA28uO5noLrNsi+I3kxMGfxsj9+d9HvPWC9DVNSb29T78cKKRN1Ru7rSuUNL0Wbt8cq1AbcY6H3qNm/HI5/vBz16+p5NDI7OWArgJsavXa+C83PdoXuHtQREQ3JNRM4mORCiFgcp+eZuTC7gfbeTsSSfvdDTanrWCdIHT/utTL3IjbJP2dfJE/U9aYTQ9/SsYrstuL+upElbztL/9LwyBq1LNWuJqi9R4MP60Zeh9somCBb266xaDU0QTtB49dYuABYUMFNvazJ51szA05pGqpK7qYJL3I0j7faKVNUZlbRMAQ46NxU1smZqgf91NqUOZvG9do8NZLz9rWoiiDsH6yoHrPCZEvkVXdIIuZp26IaRAGGSox0r3rEQxGma+JNP5bfbeNdE/54NI2NNK5CvWKQtywfC1MZHJtsumRtqTwjdqxFy3G3yLx48SGO77RjNwc0Dn2N8vbFC/JTnIJUlJ1lrkjABOuQbykJBJu+ebbLVbCA7cceSiN0xZ+dQM3Dt/CwdBLBURYv+9DtTc77b61myRw/IBWfNy4+3gHiWd4pvnk2noQ0unv23Y1r9JMJ875t0O9+iX6JhiXjouPGrRMMlwKXDDHmRzYRqba0i3TRarZeObDXHZybCpY1p0uoGdAFQ96YCbNNV/K6C0LFpYEnDMYxDUXkaKEHLZCBwLr2DDecGRPsUIUDW8uATn/8+z/kpkU+bjaS93qj1lBXpkksFeC13/ODUZnNRNWpTG0I4zx09aqMG3/hdCe/CIp9Vg1017gH67yaXuVx4ZOVxwWs7phhRyU04JoF0FevWmUhQYTrtX6cdTw6YBQd986ep6rmN4M8hz8nf8EwZ6eqd7j+21OnPM5alu7onsz/aTOWAzTrE58nkvziKctBO1ZnP08k+KWjlkP8yuHP13HxE+YuB+hVB0Bfh9/T5y//jWZtKvSVPH3kHOYAxepk6Inkvtos5gDNckpUkrwtq6Wnh8/HTZ13MtuURlHNdhvGuga+xaq8VtIEsxddz2NJVZOtUldrVlSe7y/02EaXTPVy7M6UY/kX8z8Ou+jUS60NN/2pfbxzy2qVFXvITpv12au9O4pyMNdca4DK8k/Mb7sJ +sidebar_class_name: "get api-method" +info_path: en/release-management-api/code-push/api-reference/release-management-api-codepush +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Generates a signed upload url valid for 1 hour for an update to be uploaded to Bitrise. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-update.ParamsDetails.json b/docs/release-management-api/code-push/api-reference/get-code-push-update.ParamsDetails.json new file mode 100644 index 00000000..568698f1 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-update.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the update.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-update.RequestSchema.json b/docs/release-management-api/code-push/api-reference/get-code-push-update.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-update.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-update.StatusCodes.json b/docs/release-management-api/code-push/api-reference/get-code-push-update.StatusCodes.json new file mode 100644 index 00000000..44735159 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-update.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Get the update","content":{"application/json":{"examples":{"200 - Get the update":{"value":{"app_version":"1.3.0","created_at":"2025-02-06T09:26:01.000Z","created_by":{"id":"default-user-slug","email":"default-user@example.com","username":"default-user","avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"},"deployment_id":"123e4567-e89b-12d3-a456-426614174000","description":"","disabled":false,"file_name":"main.jsbundle","file_size_bytes":13,"hash":"94b7659b8c6452b3734915a7ae01c7d24d3571fc9e2d0be3acd1b0a1b81bc6e8","id":"9a35afac-81a4-488d-a986-3c13015d70a0","label":"9a35afac-81a4-488d-a986-3c13015d70a0","mandatory":true,"rollout":100,"update_version":"v13","updated_at":"2025-02-06T09:26:01.000Z","updated_by":{"id":"default-user-slug","email":"default-user@example.com","username":"default-user","avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"},"signed":false}}}}}},"400":{"description":"Bad request","content":{"application/json":{"examples":{"400 - Bad request":{"value":{"code":"ERR_INVALID_UUID","message":"The given update id is not a uuid: invalid."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Update not found","content":{"application/json":{"examples":{"404 - Update not found":{"value":{"code":"ERR_NOT_FOUND","message":"cannot find update for the provided uuid"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/get-code-push-update.api.mdx b/docs/release-management-api/code-push/api-reference/get-code-push-update.api.mdx new file mode 100644 index 00000000..61b7f587 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/get-code-push-update.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-code-push-update +title: "Get an update" +description: "Gets an update for the given deployment." +sidebar_label: "Get an update" +hide_title: true +hide_table_of_contents: true +api: eJzdV9tu4zYQ/RVCQJF2EcmS7zb20rTJbo1mncCxA3SzgUFJY4uNLKkk5azX8Gs/oJ/YL+kMJd9ip928Ng+ORA5nztwOR0srBBVIkWmRJlbX+gBaMZ6wPAu5BjZJJdMRsKmYQ8JCyOJ0MYNEO9appSDIpdALq3u3tHT6AHj+7n51f2ppPlX4bI2MEmXhUpqB5GSjFxZWfk5DuM5VVMiguoxLPgMNUhmFCb6gpAhxSxCyjOsIn/fhDhFbnovwts5EiLjERIBk6cSALnwgqBL+yIUENK1lDgg9iGDGrS7iXmRkRmkpkqm1IvQSVJYmCnHjftV16d9BkHYMoP4gTTRaJ0meZbEIjKuV3xWJLy34wmdZvFHIbPZEA67PeZxDqWA8xygUpjyn5rhkQQIKhmOORlBHtWG7VdttDt1Ot9rsup7juu6nHTl/QboEBTuECc9jbecKpK3ifIpi6L2In+z9WMJ0gnSGIrRUJmFXCnf4nGsux7kkDZHWmepWKr7AECqws9xH/+0yInYm0zAPKBqOqjl8xr+mCX9UZKNiAAmUVJVCpV0acjLKBeV6XW9j44lXrUG90WzZ0O74tlcNazbHd7tebTa9uteqYxAOSoQWhOJ+TOmf8Fhh/icihnHpHEYicX5Xfp6EMeXS7CnxFTCGVLxdr3ZqRVxFKNup+61mo+O3g2a9UfVrrVq94zV4i4PrBa2wWg9rjZY3CTpQDV0fajwIPd/lnt/2/KAJbaplcqTDaw0+4YHd9njdrrfboc077aZdC7ya6zXClsvJkZj7EH+7+IwnWE2pXKzLXKZxnOZYMZ7rYkJNre3U1tyrWevl/66stdz/orKUmCabeliZv1OrfqzXf+IhI/oApV/W6HXT6LvHd7s8QPpD7ReDwbjXvz277J2PR6PeOWURlOJTKMmtIN6SjUXIhGJJqhk3rNdlIkGNInSsrQ/eoQ+jhOc6SiUWdfhSJzx0Yu/8M16M+mej4S9Xg96ni30v9g5vYdYOYV6DnAlFxYk3TSJejrWGWA+VPAP4+mLwsXdz07vqj88v+r0nqA/VbKHXj0S4SBClZpIik7wUeZ2i/FTHM8D7V8Px+6tRfx9wwBNzUiTh08sbO2WOt2NoambjR+NYtfcQM/ZmzG5AIlGwCylT+TJnGqbujyt6tgOGF4P+2eWeQzcpTgMR3srsES2zR5maC7pET3spcdAUtBkeNPFzpfBcVZYiXJkRhYwXA0VBKkufKxgNLlcVCTHgs42siQbpkqnMqxVChUyjosrcQwVzLgVdHcaz8mgRNUMnOyzFM+GUTOWI9OigUqBhpIahHvYodGQSZMYRME18v52rbsyqsVxOV5txBY39Cov1ZBQBDw19PmmnsyFLIKCAygXTKUNWZGfXPRbwOFYoXnLwuj1NSi0KrkgmqbEmdEwSgyJU7OMmVEaPzdZDHEVqe61UHe8AzKtXl2n6QNlcV2Uah6Tl3atX7Lc0R1BJUbxCswgkdNlrziIJkzcnx1KFEbDDNFAVPAJfnEjP4neYYeVkUszQ3z769qbE/V3V3SLHF7SKv7ce/pyjihOGFwSW0ZuTsR/z5OHk7a1n/FMZBK8r/O3n5HMy3CLGvMUx84HGYQkBXYoMaeI9+DKnSHtKM7xHWw7G6wGTm0tAh7lmC3Qz4nNgMzGV5hgmhUKRwKNR7AMGh4Qhccjov0agUILRtafY1mBCcMQVgbrJBvr0959/sdsq+7g+yD7QQfKQrsQsVRrVU97Lwtj/Fnia0uWWFF7y1VBWsIYvupLFOHuRbdOby7KL78pRg0q0i4SFLRGldH3eWcuifWW8WtEyXqs07NzdbxvVtPrBvPcs8O8H5ZfBD+wbPyWO4l+3ZbIwnGEYjgbPB2xS8w2zukepsk8JYbFxFgSQ6Z0jB9xKfLChug8XQ5qRcgrSLhU8GCooH8zH2DE4+22+xka/q9NnjiyXBdGsVhv5YuvZExsqKj0nD5DV/gEn6dd9 +sidebar_class_name: "get api-method" +info_path: en/release-management-api/code-push/api-reference/release-management-api-codepush +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gets an update for the given deployment. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/list-code-push-deployments.ParamsDetails.json b/docs/release-management-api/code-push/api-reference/list-code-push-deployments.ParamsDetails.json new file mode 100644 index 00000000..0a6826be --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/list-code-push-deployments.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"app_id","in":"query","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/list-code-push-deployments.RequestSchema.json b/docs/release-management-api/code-push/api-reference/list-code-push-deployments.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/list-code-push-deployments.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/list-code-push-deployments.StatusCodes.json b/docs/release-management-api/code-push/api-reference/list-code-push-deployments.StatusCodes.json new file mode 100644 index 00000000..86978a4c --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/list-code-push-deployments.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"List the deployments","content":{"application/json":{"examples":{"200 - List the deployments":{"value":{"items":[{"id":"9a35afac-81a4-488d-a986-3c13015d70a0","name":"Example deployment","created_at":"2025-02-06T09:26:01.000Z","updated_at":"2025-02-06T09:26:01.000Z","number_of_updates":13,"key":"random_generated_base64_key"}],"pagination":{"total_count":1,"current_page":1,"items_per_page":10}}}}}}},"400":{"description":"Bad request - The provided release management id is invalid","content":{"application/json":{"examples":{"400 - Bad request - The provided release management id is invalid":{"value":{"code":"ERR_INVALID_UUID","message":"The given connected app id is not a uuid: invalid."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/list-code-push-deployments.api.mdx b/docs/release-management-api/code-push/api-reference/list-code-push-deployments.api.mdx new file mode 100644 index 00000000..f4ef9736 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/list-code-push-deployments.api.mdx @@ -0,0 +1,69 @@ +--- +id: list-code-push-deployments +title: "List deployments" +description: "Gets a list of deployments for the given app." +sidebar_label: "List deployments" +hide_title: true +hide_table_of_contents: true +api: eJylVv9O40YQfpWVpYoWxYkdfhxEx51oSWlU4FAISD0OWRt7Em9xdn2760Aa5d8+QB+xT9KZtZPgJpyKyh/BXu/MfPPNzLc79xIwsRa5FUp6He8crGGcZcJYpkYsgTxTswlIXB0pzWwKbCymIBnP86bX8AzEhRZ25nXu555Vj4BO7h8WDw3P8rHBZ+9s7cLDZZWD5hSsl2C4C4zzk0rgujDpy40NL+eaT8CCNs61xBfcj1EjkeBnQWC/FqBn+KLhayE0oEOrC0BQcQoT7nUQ0SwnM2O1kGNvQbg0mFxJA4a+t4OA/tU5IFAu06SGKFbS4iPtRxiZiF0ard8NGc09eOaTPFu5ZT7b6ge/TnlWAD0IC5MyPUFkHPO9Az7isX8U8n1//+go8fnx0aG/F4d7QXiQvAt4gDgqKrplvBfOCaMGbiGJOMJEFO0DP2j7weEgOO60DztB2AyC4DPuK/LkP+2TxWQIOlKjqLRAtOFew3sELLinuUzUJBqDpJKityE3cLgf0VdiOudjIXlJKjWH5VkUq4IoDBFqoTWCjnAXuAXHRoTtsVwKFuVfw9vfVqYfecKo8oAs+2yAPOdaTUUCtJwBYmETLtEVccNEwoRhQiL5roHeUM19V83/E+5l0WNsdypfvx/1ru5OL3pn0e1t7wwhTcAYl7k3WI0ZwpQQI7k0cJVXqSyOaFGIpLOM0PTWVIWbVN1KXthUafEHvDn3ELOt2b+SzO3V6e3gl0/93uduPZma8Rrm3ibMa9ATYQy+YFdL8Xase4h108krgK+7/cvezU3v01V01r3q/Qv1ppsl9INtzdhDlFryjN2AnoJmXa2Vfhv8A9dm2x292kCDbv/q9KKG/Eahbqaod+yJOvFJKyd9FXr6pkhtxmCdzNoUX1p1qTMudilNhc5ww5xm+7Z/sWhVze6vm701bbcIlJ+jiremITqYci34sEqsMi1JG/EiI9FJrc1Np9XiuWgOBeqzgaZQaFrnlSahRMPIDUM/7EnY1Omq03lwvf+wPopu3KopNccdSKtzAIP9CrPl8ZECT0BvhLw+HTCcOeJTz5hVrMC4p9c9FvMsM2sBXnZ1qXDErZAj5aIJm9GOfqULl2tdID8+Wx55xBTyXMadtpvhBpjd3QulHqmYy+NXZQl5+bi7y35TBYKSbCQkCoNlKWjosPecpRpGJzvbSoUM+ImKTQtN4LmZ2kn2EStsmrkWE8z3CnM7qXB/1w7WyPEFo+LvXYg/Z+hih1musYtOdqJhxuXjzoe70OVncojft/iHL/KLHKwRY92yjA3diaUhphOD4XT9DENdENMhCiseRe+ayNcjFrfQgAlzy2aYZsqnqK9i7A4aKgpRIeHJOR4CkkObQTYp6DcZKJ0gu/4YFRQcBVtSEeibYmBOf//5F7trs8ulITsnQ8rQw6Lnylh0T3WvGsOd+/WBqhV1vlaFN9+3qka28GxbecaxjxGCG9F5Ncv3XlK/caUIkJbn5QzrbLGg5fLyRBOeCEOziqIw4pmBb6D9vl/dtH5gr2Eprware1qlWp67ECxVwV0RG8v5Iwil1WkcQ25fWG1IJnlZKdh5d4B7aQzrI/7oRrx6cPfS6pOcvfRdG98lcHd3abxiMp+XAoIELveXn161WElMuZsoekC1+gf+++OP +sidebar_class_name: "get api-method" +info_path: en/release-management-api/code-push/api-reference/release-management-api-codepush +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gets a list of deployments for the given app. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/list-code-push-updates.ParamsDetails.json b/docs/release-management-api/code-push/api-reference/list-code-push-updates.ParamsDetails.json new file mode 100644 index 00000000..19015e7c --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/list-code-push-updates.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"deployment_id","in":"query","required":true,"description":"The uuidV4 identifier of the deployment.","schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/list-code-push-updates.RequestSchema.json b/docs/release-management-api/code-push/api-reference/list-code-push-updates.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/list-code-push-updates.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/list-code-push-updates.StatusCodes.json b/docs/release-management-api/code-push/api-reference/list-code-push-updates.StatusCodes.json new file mode 100644 index 00000000..c3f1893f --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/list-code-push-updates.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"List the updates","content":{"application/json":{"examples":{"200 - List the updates":{"value":{"items":[{"app_version":"1.3.0","created_at":"2025-02-06T09:26:01.000Z","created_by":{"id":"default-user-slug","email":"default-user@example.com","username":"default-user","avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"},"deployment_id":"deployment_id","description":"","disabled":false,"file_name":"main.jsbundle","file_size_bytes":13,"hash":"94b7659b8c6452b3734915a7ae01c7d24d3571fc9e2d0be3acd1b0a1b81bc6e8","id":"9a35afac-81a4-488d-a986-3c13015d70a0","label":"9a35afac-81a4-488d-a986-3c13015d70a0","mandatory":true,"rollout":100,"update_version":"v13","updated_at":"2025-02-06T09:26:01.000Z","updated_by":{"id":"default-user-slug","email":"default-user@example.com","username":"default-user","avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"},"signed":false}],"pagination":{"total_count":1,"current_page":1,"items_per_page":10}}}}}}},"400":{"description":"Bad request - The provided deployment id is invalid","content":{"application/json":{"examples":{"400 - Bad request - The provided deployment id is invalid":{"value":{"code":"ERR_INVALID_UUID","message":"the provided uuid is invalid"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/list-code-push-updates.api.mdx b/docs/release-management-api/code-push/api-reference/list-code-push-updates.api.mdx new file mode 100644 index 00000000..2675b8b0 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/list-code-push-updates.api.mdx @@ -0,0 +1,69 @@ +--- +id: list-code-push-updates +title: "List updates" +description: "Gets a list of updates for a given deployment." +sidebar_label: "List updates" +hide_title: true +hide_table_of_contents: true +api: eJzdV9ty2zYQ/RUMZzpuPSJF6uLb5FK3VlJNHccjX2aaxKMByZWIGCIYAJSjaPzaD+gn9ku6C1I3y27rPjYPigQszp5d7B6s514KJtGisELl3pH3FqxhnElhLFMjVhYpt2DYSGlcHYsp5CyFQqrZBHIbeA3PQFJqYWfe0ce5Z9UtIMrHm/ubhmf52OB376rC8HBJFaA5eeqn6OsUnfysUjgvTbYwangF13wCFrRxkDn+QNuV06FI0UoQ2S8l6Bn+0PClFBoQ0+oSGg9CusyAlaVIrztMpAggRgI0BWdx40EwSQYT7h1hJLOC3BqrRT727ikeDaZQuUGSuN8KQ/pv0xMF5FDLZTSJyi2Cky0vCikSF37zs6EDcw++8kkhl5DMZ1sYuDPlsgT6IixMqrQg2HCKOaocR0E7CMmbBjyTDjk6RLxW1w9bfrh3GR4etfaOwigIw/DDml08c6ipS/CIl9L6pQHtG1mO0QxzIeSDvR9rykGiJmhCS8srWlnhDp9yy/Ww1ISQWVuYo2YzFphQA35RxpgLv86OX2iVlgllJjDtgE/4N5XzO0M+mo6QQEvTrCD92lFQ0M00HpTGdqls3hEtCMNjSeUy4tJgvYyEhGEdBYacB59NXOapBK/eM+IbYLLcdUTthpdxk6HtYSfe3+sexgfJXqfbitv77c5h1OX7HMIo2U9bnbTd3Y9GySG00jCGNk/SKA55FB9EcbIHB1THxPiQt7t8xBP/IOIdv3NwkPr88GDPbydRO4y66X7I6XYlj0H+e/MJz7GCFHZI3RZaSalKLI0oDPHmXH2tFdE0anuL5X8uoYXd/6KEjBjny3qgXi/4WOS8KhmSNcvlMFElNXKE7VNqTeWFVuAWXF8OUdwWS+F99a/hdR4Tip94yki0AHvdZyRQSH+K6pSuCRKqFROGiRzb3xXyM7Sk47Tkv7hZl5sExRnZ9gaDYf/s+vi0fzK8uuqfUG2BMS5Sz66jksyug62SEG0n4Srnpc2Uxt56dnQRxrNx/gnaV2fHV5e/vB/0P/Q2aW8cXtFsb9M8Bz0RhnoEk5aL53NtI9dtkCcIn/cG7/oXF/33Z8OT3ln/AettmAX17mNl1keW2FqSXYDGPmc9rZV+Hv2uK6THgZ4slcve4Oz4dIP5hcI3PcO3lN1Rzd1p5Z7Vmj3tKZKQMVg3AliS1+bqGTXOb/X0VXIwj7mBq8HpfVODBPzuo96hLyrp5rTVJEKoESZrTiMEmHItSPRdUPXRKmFOCNb0hRciqDUmEGrr/aAuqtgwgmGIw+6Ezdyb7eYHCCiwm9VodOFWTaUkbkBazhfo7FeYLeaZDHjqhO9BBR5fshwSyqWeMasY6hk7Pu+zhEtJ2anVc1HRlW5RXkU+Us6bsJIsBlWq2LtlqhyOzxZjGGVq9SC0gmiLzO7uqVK3dJE0E1LQSqaE8np3l/2mSiSVs5HIUQcsy0DDEXvBWaZh9HLnsavCDPipSkwTj8DXILMT+Rpv2ASFFhOM9wxje1nz/q4VrpjjD/SKn9cRfpwgxA5DaccKerkzjCXPb3deXUcuPlNA8qLJX33KP+WXK8Z4b1Ky2A2BGhJ6zhh21huIdUmZjlA28QXcDzBft3i5pQYMmFs2wzAzPgU2EWPtjuGlUCpyuHPAMWByyBjygJz+bQYqEMyuP0b5BJeCR0IRiE0+MKY/f/+DXbfYu8VB9pYOUoT0mBXKWISne68Lw82Uq2bauND5Sg2eP/zXVWzhq20WEicn8u/6c1438UevXI3/GTKjpXnVvFre39NyNcZTa29NZk9S/X5Qz/w/sGfM94/yvcUG3J4aa2XzPOrkhXq4P20aiz4lxtXh4ySBwq6d2pJVQlmq3NveJU03JSVoXQpunRTUX9zfU/VWPlvH3mjzBX/6vG88cWQ+r4QG872wr7aePLGUosqaMnWDqvYXrUvQ0A== +sidebar_class_name: "get api-method" +info_path: en/release-management-api/code-push/api-reference/release-management-api-codepush +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gets a list of updates for a given deployment. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/patch-code-push-update.ParamsDetails.json b/docs/release-management-api/code-push/api-reference/patch-code-push-update.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/patch-code-push-update.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/patch-code-push-update.RequestSchema.json b/docs/release-management-api/code-push/api-reference/patch-code-push-update.RequestSchema.json new file mode 100644 index 00000000..236c168b --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/patch-code-push-update.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"disabled":{"type":"string","description":"If set to true, users won't be able to download the update."},"mandatory":{"type":"string","description":"If set to true, marks the update as mandatory for all users."},"rollout":{"type":"number","description":"The percentage (0–100) of users to gradually roll the update out to."}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/patch-code-push-update.StatusCodes.json b/docs/release-management-api/code-push/api-reference/patch-code-push-update.StatusCodes.json new file mode 100644 index 00000000..82136101 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/patch-code-push-update.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Disable update","content":{"application/json":{"examples":{"201 - Full update":{"value":{"app_version":"1.3.0","created_at":"2025-02-06T09:26:01.000Z","created_by":{"id":"default-user-slug","email":"Deleted user account","username":"N/A","avatar_url":null},"deployment_id":"123e4567-e89b-12d3-a456-426614174000","description":"Textual summary of the update.","disabled":false,"file_name":"main.jsbundle","file_size_bytes":123456,"hash":"94b7659b8c6452b3734915a7ae01c7d24d3571fc9e2d0be3acd1b0a1b81bc6e8","id":"9a35afac-81a4-488d-a986-3c13015d70a0","label":"9a35afac-81a4-488d-a986-3c13015d70a0","mandatory":true,"rollout":100,"update_version":"v13","updated_at":"2025-02-06T09:26:01.000Z","updated_by":{"id":"default-user-slug","email":"Deleted user account","username":"N/A","avatar_url":null},"signed":false}},"201 - Disable update":{"value":{"app_version":"1.3.0","created_at":"2025-02-06T09:26:01.000Z","created_by":{"id":"default-user-slug","email":"Deleted user account","username":"N/A","avatar_url":null},"deployment_id":"123e4567-e89b-12d3-a456-426614174000","description":"Textual summary of the update.","disabled":true,"file_name":"main.jsbundle","file_size_bytes":123456,"hash":"94b7659b8c6452b3734915a7ae01c7d24d3571fc9e2d0be3acd1b0a1b81bc6e8","id":"9a35afac-81a4-488d-a986-3c13015d70a0","label":"9a35afac-81a4-488d-a986-3c13015d70a0","mandatory":false,"rollout":10,"update_version":"v13","updated_at":"2025-02-06T09:26:01.000Z","updated_by":{"id":"default-user-slug","email":"Deleted user account","username":"N/A","avatar_url":null},"signed":false}}}}}},"400":{"description":"Bad request - The provided update id is invalid","content":{"application/json":{"examples":{"400 - Bad request - The provided update id is invalid":{"value":{"code":"ERR_INVALID_UUID","message":"The given update id is not a uuid: invalid."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/patch-code-push-update.api.mdx b/docs/release-management-api/code-push/api-reference/patch-code-push-update.api.mdx new file mode 100644 index 00000000..a2ffda5c --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/patch-code-push-update.api.mdx @@ -0,0 +1,69 @@ +--- +id: patch-code-push-update +title: "Patche an update" +description: "Patches an update." +sidebar_label: "Patche an update" +hide_title: true +hide_table_of_contents: true +api: eJztWNtu40YS/ZUGgYWTgSmRutpCJoEzdjbCzjiGLwNsJobQJFtijyk2t7spj1YQkKd8QPKH+ZI91aRuljyJH/Kw2PWDTHVXV52qPnWhFl4iTKxlYaXKvYF3xW2cCsN4zsoi4VY0vGPPiLjU0s69wYeFZ9WDgOSH++X9sWf5xODZu3OyxsOSKoTmpG2YrPS9UYm4Kk1aSUFhwTWfCiu0cSpzfIGsTLAlCUXBbYpnLf5VSi2gx+pSAAegTbk3AIh5QSeM1TKfeEuCooUpVG4AAvutIKR/u76dS8OjTNSOQX+scityS5K8KDIZO9zNj4bEF574xKdFtlbIfPZdmWWr41ic8awU9enRDN5UdsJGuxGQei0gmIw4LEBBq+sHLT/o3Qang1ZvEISNIAh+3JKL5qRLUtgSMeZlZv3SCO2brJxADK7LjNwQGUKXMNpjPI5VCReOPfpaB/KyeYYFPuOW61GpcSgH8OUx1BaZmk/h88iZCVtt0en2+r44OY38sJW0fY7vfqfV64WdsN8BQu/4SRhvxSdb8oyZcjrles7UmNlUbNElqeIMA2OeGdzbWGZiVGODE3njo4nKPMnoDtyekf8WcJ8YNAAmQDj2Um5SyJ92on6vexqdxL1OtxW1++3OadjlfS6CMO4nrU7S7vbDcXwqWkkQiTaPkzAKeBidhFHcEydEKXL1lLe7fMxj/yTkHb9zcpL4/PSk57fjsB2E3aQfcHI145HI/rz4lOfwWun5iqJaZZkqceFhEOBOXEy2qDEL295q+Y+JsZL764lh5CRfX9gSCxXfn2TM/yn/x5SvaPA/wfg6u7co/9/LePo79nD5+23jW54w6kTCWKTELe690GomE7Lr4DKZMGmYzJEcroe9oK/AIpS+1MR2IsZorkB5cX09Gl6+P3s7PB/d3Q3P6aqEMXxCm6RxImci31WXK8s4K0uZDFaqG94mFgda6F3OS5sqDfa+2FEqKDvnn/Hi7vLs7vb7H66HP17serFzeAOzvQ/zSuipNMRAlohcvhxrG1j3lTwD+Ori+t3w5mb4w+Xo/OJy+AT1vpoV9O4htg2BEuTN2I3QyCJ2obXSL4PfdZw6rOhZ5txeXF+evd1BfqMwo6UYsNgjLLNHrdysVaOv+fqtSuaVss/i2xvdVPRRxJSsYDomRisr7JtC+nTIe1qTh2NmhGVWMVdyXQ0w7FHlR5ZFgrm+hc1EPeaZQn5tF+zlTh17qSW0gAezpY9xw9bq2FihFNGYSHicqXWBXBvKy2kk9H6bocQXOkYccQPsi+D3n3/DHPEl9ZvKPWCYaJ6gF2VzRnq3YcAGBDYZTLenkmqcjlM3dltqMM1K3jQXMlm68Z4IUo3irkR6i4gbcXf9dtnUqLB49uEfIFEbbc5aTWKOX2Cib85CKJhxLSne7gbroxWzXemGwtTawgyaTV7IRiQRZiMaUh0MQIWGkRoGPexR2tR56SgknHv3m3eSG7fqLNdvJusow9g/xHz1TpEKnhyI+dXZLctFTKTH5SG+CDQ7uxqyGDE2EK8byar0OFp7FF6i9vUmCS6qDNwl8YZSW3zbLK6ZESwJ5Vg59NKSGu+6Cj17tw69w+Wz1esURX7TZ1uNcM+5V6/eKvVAGUyspCCqLCEt37x6xf6pSjiZs7HM0Q0sS4UWA/YVZ6kW49dHh64eEfUTFZsmjohPjdROs2/AGNMotKTB6BKxel3j/lsr2CDHF1jF5/sQH+dQccTQkSfCvj4aRRnPH46+fh86/0wh4q+a/Ouf8p/y2w1i8ABsR2JjoNMipimBoaR+JyJd0s2FaJ0YLPoNxOsBZCk10j/lls3hZspngk0lUoeOUSJDcS4eneJIIDgkLPIGGf1sBColiK4/QdsULgQHXJHQTTbg0++//Mret9i71UH2dzpIHlJtKJSxUE/3XhNt7w386a1u1drDr+s1/S2G1maRYfokQy6xF3UJ+FAPWsTvAeYJ5FMKILSxqHJfZ8slLYPeRNkP95ssd3Vi7x3vWYhfXNdv8V+y57Ct8jWfu2Li2pOHxwcxr34WWN5Dqk5gsl5tvKls+Ld0fHNwr/0sj1cnzuJYFPazsvdbdRO14c33kI7qHjetGqbmj5S7+HQolXPaVSC3tsBInU/KqodWSqlcUAHZLU4PrjjVD+6nlUNx2C08q6DQJ/l18MhiUZW+5XItX209e2JdHOuQUyCA+j/Jm/8e +sidebar_class_name: "patch api-method" +info_path: en/release-management-api/code-push/api-reference/release-management-api-codepush +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Patches an update. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/pause-code-push-staged-rollout-schedule.ParamsDetails.json b/docs/release-management-api/code-push/api-reference/pause-code-push-staged-rollout-schedule.ParamsDetails.json new file mode 100644 index 00000000..4a74d2c1 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/pause-code-push-staged-rollout-schedule.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"update_id","in":"path","description":"The uuidV4 identifier of the update.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/pause-code-push-staged-rollout-schedule.RequestSchema.json b/docs/release-management-api/code-push/api-reference/pause-code-push-staged-rollout-schedule.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/pause-code-push-staged-rollout-schedule.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/pause-code-push-staged-rollout-schedule.StatusCodes.json b/docs/release-management-api/code-push/api-reference/pause-code-push-staged-rollout-schedule.StatusCodes.json new file mode 100644 index 00000000..114aeb24 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/pause-code-push-staged-rollout-schedule.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Pause staged rollout schedule","content":{"application/json":{"examples":{"204 - Pause staged rollout schedule":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Schedule already finished","content":{"application/json":{"examples":{"412 - No schedule exists for this update":{"value":{"code":"ERR_NOT_SCHEDULED","message":"No schedule exists for this update."}},"412 - Schedule already finished":{"value":{"code":"ERR_SCHEDULE_ALREADY_FINISHED","message":"Cannot pause: already finished."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/pause-code-push-staged-rollout-schedule.api.mdx b/docs/release-management-api/code-push/api-reference/pause-code-push-staged-rollout-schedule.api.mdx new file mode 100644 index 00000000..8e77b048 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/pause-code-push-staged-rollout-schedule.api.mdx @@ -0,0 +1,69 @@ +--- +id: pause-code-push-staged-rollout-schedule +title: "Pause staged rollout schedule" +description: "Pauses the staged rollout schedule for the given CodePush update." +sidebar_label: "Pause staged rollout schedule" +hide_title: true +hide_table_of_contents: true +api: eJytVu1uIjcUfRVrpCptFBhgU1VCm12hhG1QCUF8RNpmI2RmLozLYM/aHhKK+LsPsI/YJ+m9nhkIAbKN1PyYeBj73HOO7WOvvBBMoEVihZJe3evy1IBhNgJmLJ9CyLSKY5VaZoIIwjQGNlHafZ+KBUh2qULopiZiaRJyC2XvzDMQpFrYpVe/X3lWzQCB7x/WD2ceIhpse0PX13j4k0pAcyreCovyBWTfEehl9ft5ecRPuOZzsKCNqyDxBYdm9UcixB6CpCTcRtje1TdA4mkqwrtzJkKQVkwEaKYmTtFWgoavqdCAlKxOASVh9Tn36qhnmVA1Y7WQU29NqjSYREm0jb7XKuf074CrxwzFcoGSFsnQQJ4ksQicI/5fhkavPHji8yTe4LMSex0Quy14nFJj7f7OvPNKdZ/WUPLURkqLvyF8GwuEQxY7458VRaSQTGr2eqNhpzEcXN/2Wn82r7DGHIxB0i+Lb2m+O+Ae6LkwBl8YTpl4O9d35NgeyBHC3WbvptXvt247o6tmp/WC9T7Mhnq1tk+9WLWMxxp4uGQTIYWJ3iyhWkMJHbXdhPAkjDX5XhQmX7rHNHVuB6P+5XXzath+oefHmGUvV4cMjss5UrgoOmq0e83G1efRp1an1b9+QeKSS6ksS2hR1/ewyxuLf61U9i1uoYta8pj1QS9wLze1Vvpt9iIuijsMdERYqzNo9jqN9o6OvsJYijAX2CNWZo9auYjI2dM3RSGXKGNdjGE+1T0/s9n4q02Crf1sZ5fynV0qpsh3FrmIJYpZ/qU6RpjVmBsY9tprX0MM2C7NuUSQOTLxFzWfuJcSTFV/UUWABdeCj3P9+dDM2wlPY3TNi6xNTN33eSLKY4FxZ6As1MFAzdgwgmGIwx6FjbIjhGLTrSDKyeJc6LtfXeX8dNjEKhb7A5ZFgke4DkDvlew2BkxCQLbrJbOKURY2ui0W8Dg22D0/EYp8cRPvVrGQE+WqCUsx6fUyq9jNxiqHU9qcauQU+pzVXdTK1T0yp6dtpWY058W5qOKQUD6enrLPKkVSkpZyyIRlEWhc4O85izRMLk4OTRU6UApVYHwcAk/lyM7jjzjDppxoMUe9HdR2kfP+qVbZMscXrIrPuyo+rhDihFmup2AvTkbjmMvZyYe7qtNnEgje+/zDF/lFDraMcd7imI0Bky3RgPsFzxbMuU8w1ik5XTWW1Sq138ro1wwnN9WAgrllS5QZ8QWwuZhqNwwnhayQ8OiAx4DmUGeQZSr6qgMZCLpbmuJBDc6CA1IEYlMN1PTPt+/srsZuioHsdxpICj2cdNpuCE/zni+MHx3HOzO82ibJ/3I7yle6hSfrJzHHhY4c3R5e5ZFwn99laCnXn19rjqSCyxLKBdxjEWULIqyyPNDxek0/f01B033sYbvzXXaEwlAbU2nCYwOvSP+5l1+JfmH/8Q51UGixz+XShZALVg+bM9z1z+9w6wfsnO9/Ipp9bwQBJPbZyL1kp5zZBG33tj/AzpQDuxkzcxmTN9wt9RCt3fwoONJzfXZkyGqVJRi6XvTPPh0dscm4rDe59IBx+S/tNfy+ +sidebar_class_name: "post api-method" +info_path: en/release-management-api/code-push/api-reference/release-management-api-codepush +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Pauses the staged rollout schedule for the given CodePush update. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/promote-code-push-package.ParamsDetails.json b/docs/release-management-api/code-push/api-reference/promote-code-push-package.ParamsDetails.json new file mode 100644 index 00000000..194d7a21 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/promote-code-push-package.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the source deployment.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/promote-code-push-package.RequestSchema.json b/docs/release-management-api/code-push/api-reference/promote-code-push-package.RequestSchema.json new file mode 100644 index 00000000..94193f40 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/promote-code-push-package.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"target_deployment_id":{"type":"string","description":"The uuidV4 identifier of the target deployment."},"package_id":{"type":"string","description":"A uuidV4 identifier of the source package."},"app_version":{"type":"string","description":"The app version (e.g., 1.0.0) that this update targets."},"description":{"type":"string","description":"A description of the update to display in the release history."},"disabled":{"type":"string","description":"If set to true, disables the package immediately after upload."},"mandatory":{"type":"string","description":"If set to true, marks the update as mandatory for all users."},"rollout":{"type":"string","description":"The percentage (0–100) of users to gradually roll the update out to."}},"required":["target_deployment_id"]}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/promote-code-push-package.StatusCodes.json b/docs/release-management-api/code-push/api-reference/promote-code-push-package.StatusCodes.json new file mode 100644 index 00000000..73bdf05a --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/promote-code-push-package.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Promote package","content":{"application/json":{"examples":{"201 - Promote package":{"value":{"app_version":"1.3.0","created_at":"2025-02-06T09:26:01.000Z","created_by":{"id":"default-user-slug","email":"default-user@example.com","username":"default-user","avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"},"deployment_id":"72a1ff34-67b6-470c-a095-27381bbe8904","description":"Description","disabled":"false","file_name":"main.jsbundle","file_size_bytes":13,"hash":"package_hash","id":"123e4567-e89b-12d3-a456-426614174000","label":"123e4567-e89b-12d3-a456-426614174000","mandatory":"true","rollout":"99","update_version":"v13","updated_at":"2025-02-06T09:26:01.000Z","updated_by":{"id":"default-user-slug","email":"default-user@example.com","username":"default-user","avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"},"signed":false}}}}}},"400":{"description":"Bad request - Validation error: invalid rollout","content":{"application/json":{"examples":{"400 - when target_deployment_id parameter is missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: target_deployment_id"}},"400 - Bad request - The provided deployment id is invalid":{"value":{"code":"ERR_INVALID_UUID","message":"the provided uuid is invalid"}},"400 - Bad request - Validation error: invalid app_version":{"value":{"code":"ERR_VALIDATION","message":"validation error: field app_version failed on: semver"}},"400 - Bad request - Validation error: invalid rollout":{"value":{"code":"ERR_VALIDATION","message":"validation error: field rollout failed on: max (100)"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/promote-code-push-package.api.mdx b/docs/release-management-api/code-push/api-reference/promote-code-push-package.api.mdx new file mode 100644 index 00000000..e54b06bd --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/promote-code-push-package.api.mdx @@ -0,0 +1,69 @@ +--- +id: promote-code-push-package +title: "Promote a package" +description: "Promote a package from the source to the destination deployment." +sidebar_label: "Promote a package" +hide_title: true +hide_table_of_contents: true +api: eJzdWOtu2zYUfhVCwNALIlmyc1mMXuYtWWesTQPHCbBlgUFJtMVGEjWScuoZBvZrD7C9YZ9k55CSLcd20wz9tfxwbIr8+J3bx0PNnZipSPJCc5E7XedcikxoRigpaHRLJ4yMYYTohBElShkxooX5Bcs0zykug+9FKmYZy7Xn7DmKRaXkeuZ0r+eOFrcMcK9vFjd7jqYTBd+dk+V85cCwKJg0QP14xeAHEbPzUiXnlgbgFlTSjGkmlUHO4QdM5zE84ki9oDqB7+v2DIFqWfL4ap/wGDbkY84kEeOmRev0Jfu95JIBFS1LBuZECcuo0wVbZgXuqLTk+cRZoEWSqULkiil83vYD/LfdocXSjkjkGvbCqbQoUh4Z21sfFM6fO+wjzYp0iUhcch8CHkxpWrIKYTQFl9jNAq/j+biFZFSzeERhFwBpH7h+2/UPh/5xt33Y9QPP9/1fG/PCGWJxdH/MxrRMtVsqJl2VlhOYBvbz9N6z7yqeXiQymIJDVUSas+AJnVJN5aiUiJBoXahuqxVycKJiblGG4AC3colbSBGXEbrDUx2PZvQPkdM7hXu0DCEOM1XLQrrVRl6B0cDA12EcGUuO2jQYjzv77uFReOjuH/mRS/3jA7d91Pk2CEP27bG/v5EvJ41f8IwrGqaYC86YpgqjN+YpG1WWglty74MKyzxOl88U/4OBQzVGMOjsOQlViclOE7yR+blnfR20O2z/4PDIBS6hG7Tjjkvht7vfPjwM9oOjfQgTzE1pyNIvn57RPKZaSIipgymMOS3SVJSYDMfHGKwCJrBG3kyDznL44ayp5/0vskbxSY4BNvFdmL89Bzy5Wcnf05igOIDwQVFe0ZTHVv6YlEJ2Cc+nOEZqZz+q0mFHAL1LWE6A5ITp0Vo6k6X4Ea5IxpVCCWoKQQR6CSRPB4PReW/Qe3c6PB2M3vUvLvpnbzApmFJGO6yMNlCIkEYMDRKOs6zQMxytDOpuZeRUfgLW645BxYWITEFu44a0gvwieIW5i3r/7Kr3tn8yurzsn6yx1k1UFPQm2C4qu2O0JpvbqRgivWH//dkakekGJpwo6RoiGUPiA02Rd4liGYz+B4bLkv0q7Cq0JrOMfiRPA99/5qyyfsv5dZnTUidCgqrFj01pPLzW1u8w5vKsdzn86f2g/+vpetTXFq9odrYcs0yafDbdSM4fz7WDB+0GyK4KOx2Y0np/Njo5PevfY70JU1M/2KYrfWAJKpiSCyYhV8gpBu5x9A9Mam0H2llpIBBnvbdrzC8EaEyConCHJXsnhWl0KvZV2n4v4pkF+yy/jb5JhB9YhLIIdQwdn+aW+1Zx2ei2HtXXWci1vm6xtzyBvwS+92DTWKEZ5Htq8jBzWEBqsXjKvIm3R+B09fxnsAPV8AHiZk/Zyhbl2Q6nAfSwCY3fNfkaVBBobYqUzkBvzAPJUkYVI7Aztg52u2X389Be/TEInTZXA+yZSbVSGej6IsGzjMUctk9nhI7xKCshPjQ2ezWalsdullF5q5rWUTjbajgyhoOMpinBRsB6saGsD0cKEjWCDED+T/1Pf/6DgonONHDIYSJpXMIGM6OxTRqot1p4Tl069lJxvT3hb2yJYfkJbKgKoUyp4J2m67RWk1VrzuNFq7B3AnPdwmK3dyLbLs1DiOTl4O2iVUXVBXeABbi8NW23UAWgh1JJaxoAwJRKbqKFHqmWWpUyjVKj/6IF96oezONiq78sG4IwBHDIHdeJLRuUAywXc2+q74gXZtTqgL0pLoMCm/3MZvXlLmE0No3hPdnvDUnOIhQwiDWEA+JCeud9EkFIFEyvusv6GDESZSKCMjVYCdqpVdPdgrRKkqaOrEbXL2I7Mmo1vLpYLMeafftycNW519dOdMhYGKJcI2NnUNXuu2WUjQtcUt+hMcirXr/tBRvEnj9/K8QtCv+4agcFdA2A8vr5c/KLKMGf0NbwHNouTRImWZe8oCSRbPzyybYsg+C5sYhUC5awj16is/Q1JKfyCsmhXmdnEJaXFe9v2v6KOfyAXeHzKoCPE4B4UkngyyejMKX57ZNXV4GxTxUsetGir37Lf8uHK8aQclCHobnWSxbhTQX6HfIjC2WJSRJA4wWXmyMP/HULeVlKZlV3BmYmdMqgMYaixmXVq46c3RngkIFzcDLLPdz0sx6wIOBddwInCTMu2GIKB2zcA2z69Nff5KpN3tULyRtciBaa0wsEAeAx7lVOb7yq8e6HtXFGf40XO1VhavZRt+DsgLoEXkZy5pVQXTcu4Vh9XfN2ptYqqPsEZQ2mza1GyXSxwGEoQ0z765uVGhk9W5WJuZ59xryng0phn5HHv/LZalgtQ/nMaKTpoBz4estm9rXT4gZmVbqEZO2DH6pL6RCXrxZudEiLvXpFL4pYoT8796ZxMpy/vxjC5LDqwjLb0kl6h2oBn4akMC4yumrG5g7k26S0XZ7FRBFEWVyX3FsjudUX8wJvmxvW5bT2CX6iWVuXzOdW0CHg9Xz7aOeKpeRXHkc/AOt/AeP1FwI= +sidebar_class_name: "post api-method" +info_path: en/release-management-api/code-push/api-reference/release-management-api-codepush +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Promote a package from the source to the destination deployment. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/release-management-api-codepush.info.mdx b/docs/release-management-api/code-push/api-reference/release-management-api-codepush.info.mdx new file mode 100644 index 00000000..b60dede6 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/release-management-api-codepush.info.mdx @@ -0,0 +1,81 @@ +--- +id: release-management-api-codepush +title: "Release Management API - CodePush" +description: "**Looking for the old API?** You can find it here: V1 API spec" +sidebar_label: Introduction +sidebar_position: 0 +hide_title: true +custom_edit_url: null +displayed_sidebar: releaseManagementSidebar +--- + +import ApiLogo from "@theme/ApiLogo"; +import Heading from "@theme/Heading"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; +import Export from "@theme/ApiExplorer/Export"; + + + + + + + + + +**Looking for the old API?** You can find it here: V1 API spec + +The old API will be deprecated on February 1st 2027. Make sure that you have migrated to the new API before then. + +View the V1 → V2 Migration Guide + +
+ + + + + + PAT necessary to use API calls + +
+ + + + + + + + +
+ Security Scheme Type: + + apiKey +
+ Header parameter name: + + authorization +
+
+ + +
+ \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/resume-code-push-staged-rollout-schedule.ParamsDetails.json b/docs/release-management-api/code-push/api-reference/resume-code-push-staged-rollout-schedule.ParamsDetails.json new file mode 100644 index 00000000..4a74d2c1 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/resume-code-push-staged-rollout-schedule.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"update_id","in":"path","description":"The uuidV4 identifier of the update.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/resume-code-push-staged-rollout-schedule.RequestSchema.json b/docs/release-management-api/code-push/api-reference/resume-code-push-staged-rollout-schedule.RequestSchema.json new file mode 100644 index 00000000..493db0fe --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/resume-code-push-staged-rollout-schedule.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"location":{"type":"string","description":"The time zone in which the schedule dates are provided. It can be any TZ database time zone or UTC if the dates are given in Coordinated Universal Time."},"schedule":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the existing schedule item, returned by the corresponding GET endpoint."},"percentage":{"type":"number","description":"A number greater than 0 and less than or equal to 100 representing the release percentage, where 100 indicates a full release."},"when":{"type":"string","description":"A date in ISO 8601 string format specifying when to run the schedule."}},"required":["id","percentage","when"]}}},"required":["location","schedule"]}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/resume-code-push-staged-rollout-schedule.StatusCodes.json b/docs/release-management-api/code-push/api-reference/resume-code-push-staged-rollout-schedule.StatusCodes.json new file mode 100644 index 00000000..f4358da0 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/resume-code-push-staged-rollout-schedule.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Resume staged rollout schedule","content":{"application/json":{"examples":{"204 - Resume staged rollout schedule":{"value":{}}}}}},"400":{"description":"First step does not exceed current rollout percentage","content":{"application/json":{"examples":{"400 - Invalid time format":{"value":{"code":"ERR_INVALID_TIME_FORMAT","message":"when must be a valid datetime string; given value: 'gibberish'"}},"400 - First step does not exceed current rollout percentage":{"value":{"code":"ERR_INVALID_PARAMETER","message":"first schedule step (50.0%) must exceed the update's current rollout percentage (100.0%)"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Schedule already finished","content":{"application/json":{"examples":{"412 - Schedule not paused":{"value":{"code":"ERR_SCHEDULE_NOT_PAUSED","message":"Cannot resume: schedule is not paused."}},"412 - No schedule exists for this update":{"value":{"code":"ERR_NOT_SCHEDULED","message":"No schedule exists for this update."}},"412 - Schedule already finished":{"value":{"code":"ERR_SCHEDULE_ALREADY_FINISHED","message":"Cannot resume: already finished."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/resume-code-push-staged-rollout-schedule.api.mdx b/docs/release-management-api/code-push/api-reference/resume-code-push-staged-rollout-schedule.api.mdx new file mode 100644 index 00000000..318323f6 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/resume-code-push-staged-rollout-schedule.api.mdx @@ -0,0 +1,69 @@ +--- +id: resume-code-push-staged-rollout-schedule +title: "Resume staged rollout schedule" +description: "Resumes a paused staged rollout schedule for the given CodePush update." +sidebar_label: "Resume staged rollout schedule" +hide_title: true +hide_table_of_contents: true +api: eJytWOtuIjcUfhVrpCrbKFx3t63o7lY0YbuoCYmARNpmo8jMGPBmGE9tDwlF/O0D9BH7JP2OPTAQIGmq5scwF/uc79y+c5x5EAkTaplaqZKgEXSFySbCMM5SnhkRMWP5CD9axbHKLDPhWERZLNhQaWbHgo3kVCTsWEXiIjNjlqURt6IcHAVGhJmWdhY0rueBVXcC4q9vFjdHASQa3AeXbq0J8EqlQnOC0I5WIJYyew5B1wPo5fqhIOWaT4QV2jgVCR6w1wO4lRFWSLIo5XaM+00z+0CeZTK6esNkJBIrh1JopobOpMIGLX7PpBbAZHUmYBO0T3jQgEGzlLQZq2UyChZklhYmVYmBQfher76hn13O3edS6AtVYoGGdvI0jWXofFL5amj7PBAPfJLGKwWsxJ6RiHVTHmd0s3B/R8GbanUb2EepDbZZkbJIIfqJskw8hAIyEUQNSCvZCFSIZ+h7GV7oBd52AjwyYlZOXApNuF0HCYERubXV7d62O1fN0/bJbb991rr9eN49a/ahEblpSHcjuB8j7yYZcA8E0tXLpcA52T4wP+bp6eQ32MFIDgZCSzM+CHJfANN/M/4Z1BfNbvOs1W91NzAPvaplDTmdr95Wy9VvvvWm5HqLLDwwT4Bgr2pVtzkoolvbju5lwjM7Vlr+IaKXBq0GB23s32P3Zad52f903m3/1jrZMHljcwHz9TbMC6En0hg8MJSkfDnW18C6LWQP4ItW96zd67XPO7cnrU77EeptMSvotfo29CUrMR5rwaMZG8oEWfZiE2p1mLASRonoWXifEb3jT62Ty9PWbee8j5S77D0y45gnJEQ7lmgUiSfNmvBykNsF3R1VLBIP0liTEz12+ITcB4UQLOFsgnhe5jqC/a58zgfN026refL59mO70+59etoTj4WXV/F9u4sf2wihTnjMekJP0ShaWiv9sti+zflvl6C9XAL+6DRPNwzpKfS8MbiN3RMp3Gvl+k+OnhqWMPZnFc28sCfxbbUzNfgqQku9VVNHttJjj5XfuN34dvVVx79/qARplrD7sQzHjs9WOeCaPuNaMGiZov1GZda2LOSJY/Jkxvq/0SI+4GZdGnLmsn/MpG/ShRRP8ZKGEKUjmeBDBM7CW23g6T4EILy+eS+7Ym4F15rPaFCwYmKe94OM/p0H0IjyUcLlOwWrKD2oOkIe2kwnwDmYuXWh0n58iGjxL60+E0mUKplYB32z7+QAkmyCZrYFoMn8BzZCiiPbIB+ercKxEUMuGv8MZyJV4B6rGJoIAKUAQJMQ9BMiLWJB/i9UHyGYAv6m5RJAQx8BNszieLncoaXO/Lyjmi6EFLd275z98B1ajV+ZzwXMpCKUw5lLder1QKqzZCOXPHEUU9p14Oa+jRnFoblZPF64yum1xLjxRUQFpmgOTZVxSUATZCOoeLIylflqxlxU/ORVyntzaSmq4onGjcFU6H5EzXQMOXPK68vu6aKSO6004QmkTAC5Mq1XiAFKKQbfyrQGAVOuJR/kLJJv9Qw15FmM2g7G1qamUanwVJYHEj5EHKTamZkeDXOVBTnsXtqiOl2duFF2Obv33FtfGX6CL0onlb+K2XLIHoNNd+TiRbPPEhESeekZBRD9hjUv2ij2ODZYng/tyxHBR4RiQBTVLcis5Zl0k4yKzCpK+9pXafFpvXSqy9xcze03CzJgqJxh0pIETOk+889WUXGQS6tDDgUFIfUYpvVybcvuw8NTpe7yXHb+VXFEUn46PGSfVebIDr0nAh0wKqoGe8fZWIvh+4NdWQFnlyIVmgq2iIfy2E7in5BMppxqOYFrO3Dj+xz3N/VqgRwP0IrrVQ2XE4g4YJbrkbDvD24HMU/uDj5c1Zx9VG7vKvzDl+RL0i8QI0VQ3iDmiBgidOSKqeijGOiMglrD1Fqv1r8vw193yKMMDAGGsWwGM8d8KthEjrTbhviTKxJx7wQPBJxDi0VSJqVPesALgXdLIxzbhHPBDlMkZJMO2PT3n3+xqzo7W25kv9BGstAxKkob4inueQ4+ezjbCPFab/0fz8x5bVnxYCtpzFFagOpYY56z0HV+wKXiaayfdfcQkTvEOipCWY+JzyBi7ilIx4sFvUaVaTqm3xRk4wopkobuUU5DHhvxhAdedXNm/Zb9y5P1TkuX1JLMHO+5iSjA7R2IZv1k78o2pxwC6r8fezilPkkp9m8NPouj5Y5mGIrUPrn2Zq0dXJz36Ag6yIeriZ/UNL8nJ+PqsCrnHkeZ7h0IiyejzA9vXibxGzHeJpveOTbNb9z/THZ5Y5Mpl66hK5m1c8t87rkawV6u95/27lixuV9NwaHW+A9htEGb +sidebar_class_name: "post api-method" +info_path: en/release-management-api/code-push/api-reference/release-management-api-codepush +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Resumes a paused staged rollout schedule for the given CodePush update. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/rollback-code-push-package.ParamsDetails.json b/docs/release-management-api/code-push/api-reference/rollback-code-push-package.ParamsDetails.json new file mode 100644 index 00000000..9f946177 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/rollback-code-push-package.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","description":"The uuidV4 identifier of the deployment.","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/rollback-code-push-package.RequestSchema.json b/docs/release-management-api/code-push/api-reference/rollback-code-push-package.RequestSchema.json new file mode 100644 index 00000000..27d157f7 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/rollback-code-push-package.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"package_id":{"type":"string","description":"A uuidV4 identifier of the package to rollback to. Defaults to the previous version if omitted."}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/rollback-code-push-package.StatusCodes.json b/docs/release-management-api/code-push/api-reference/rollback-code-push-package.StatusCodes.json new file mode 100644 index 00000000..60843356 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/rollback-code-push-package.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Rollback to a specific version","content":{"application/json":{"examples":{"201 - Rollback to the previous version":{"value":{"app_version":"1.3.0","created_at":"2025-02-06T09:26:01.000Z","created_by":{"id":"default-user-slug","email":"default-user@example.com","username":"default-user","avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"},"deployment_id":"123e4567-e89b-12d3-a456-426614174000","description":"Description","disabled":"false","file_name":"main.jsbundle","file_size_bytes":123456,"hash":"package_hash","id":"5093c888-3bf8-4c4b-a48e-bfc4d709ee68","label":"5093c888-3bf8-4c4b-a48e-bfc4d709ee68","mandatory":"true","rollout":"99","update_version":"v13","updated_at":"2025-02-06T09:26:01.000Z","updated_by":{"id":"default-user-slug","email":"default-user@example.com","username":"default-user","avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"},"signed":false}},"201 - Rollback to a specific version":{"value":{"app_version":"1.3.0","created_at":"2025-02-06T09:26:01.000Z","created_by":{"id":"default-user-slug","email":"default-user@example.com","username":"default-user","avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"},"deployment_id":"123e4567-e89b-12d3-a456-426614174000","description":"Description","disabled":"false","file_name":"main.jsbundle","file_size_bytes":123456,"hash":"package_hash","id":"5093c888-3bf8-4c4b-a48e-bfc4d709ee68","label":"5093c888-3bf8-4c4b-a48e-bfc4d709ee68","mandatory":"true","rollout":"99","update_version":"v13","updated_at":"2025-02-06T09:26:01.000Z","updated_by":{"id":"default-user-slug","email":"default-user@example.com","username":"default-user","avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png"},"signed":false}}}}}},"400":{"description":"Bad request - The provided deployment id is invalid","content":{"application/json":{"examples":{"400 - Bad request - The provided deployment id is invalid":{"value":{"code":"ERR_INVALID_UUID","message":"the provided uuid is invalid"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/rollback-code-push-package.api.mdx b/docs/release-management-api/code-push/api-reference/rollback-code-push-package.api.mdx new file mode 100644 index 00000000..eccacebe --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/rollback-code-push-package.api.mdx @@ -0,0 +1,69 @@ +--- +id: rollback-code-push-package +title: "Rollback to the previous or a specific version" +description: "Rollback to the previous, or to a specific version if specified." +sidebar_label: "Rollback to the previous or a specific version" +hide_title: true +hide_table_of_contents: true +api: eJztWNtu4zYQ/RVCQJE2sORrEsfYS7ObtDWazQaOE6CbDQxKGlvcyKJKUs56Db/2A/qJ/ZLOUJIvsZ02RftSbB4ciRzOnLkPNXNC0IESqREycTpOT8axz4N7ZiQzEbBUwUTITFeYVLTGmU4hEEMRsAkojYeYGJZrEHpOxdEQZEqYqdO5nTlG3gPyvb2b31Ucw0can51TSGM5HUNitIPLMgXFSX43XEHwVoZwmenoEp/5CJBxyhUfg0GxlnWCL0gvQtwShD3lJsLndYX6qESWifCmxUSIEgmmYnJotQsXQAi4gl8zoQBBGJUBKhJEMOZOB7WYpiRKGyWSkTMnXRToVCYaNO03anX6t9uUm2ZDeYFMDIqmkzxNYxFYI1Q/aTo+c+AzH6fxQgBz2S7nLHgi5YTHGRQsB4t1p+41vRrJVMANhAOOYpFr48CtNdzaYb923Gkcdmp1r1arfVih86fES5BjQhjyLDZupkG5Os5GSIb2EfGjve8L4F4gx0hCS4WrVqlwh0+44WqQKeIQGZPqTrXqCzSyBjfNfLSIW9jITZUMs4Ds4+mmx8f8i0z4gyYZVQtIIKWu5izdQpCXkrcoIko3D6wm9UYTWgeHRy60j3233gibLsd3t9U4PKy36kctNMJGIJ2uvOGe0NyPKVacIY81hedQxDAoNEWzJN4n7WdJGC/2tPgCaFBDLkUIKLHiRFxHNnRtkA/sayW390HtuBm022236Q/bbito+YiyDa4/DFrhUe0Y4LCNtDH3If775GOehNxIhX51KMwp7jGsZEYBcXxMDkuRAFZiZ1JvLpb/OnJKuv9F5GgxSsjJ1sdzXNhMxC2p/TUNv6bh1zT879KQ/ioOhsdm033DQ0Z9HLTBPO3bJikn2PnDlWaPkwATmokEs9SOD8/oxCgVGf8TMatVIcDhBtGe9XqD7sXNyXn3dHB93T2lwACtadzBsFjlSiPMKrOlEbZMHtcJz0wkFQb6s7Wj8rZ2fgfs64uT6/5P73vdD2frsNcOL2E2N2FeghoLbWdInMzE87E2Eesmkx2AL89677pXV933F4PTs4vuI9SbbEroB9vCrIsoMSlidgUKM5SdKSXV8+Af2EDazmhnqPTPehcn52vIryTOxBHOpeyBYu5BSTuiFuiLIH0jw2nO7El8GxOv9D9BYGj2VjSlG5FjL+tkHtXr0/Hjgn2ye/wu2FAXVcuO6rHTPPv1rjmXrhxyLIyhC0epKVlBUplLpbaI6TbQcarLfNTVmQjn1VKUvaqQ0fPrRF7FZj7XcN07RzKIAZ9drNSIkc5XJ40qeQNLm46qkzoymHAlqAFZqxRH82ixGqyURZ4KryiNnpBbryk5GkZsGPJhD8JEVn/rFrCq3i3vV1d21UoublkLV6Cwn2Fa3osi4KGt14/S76TPEggokNSUTI1lmJ1cdlnA41gjeVH0y3S2oeKQqSlcesvAOsuj+nFgLK5LBGMoLTxhiM7p5bZl7xa2tYJdVl76yLTLxtfw6hvo9/fPpbynsB/SzRStJOOQuLze32e/yAy1SNhQJFg1DYtAQYe94CxSMHy5t823aDI3lIGu4hH47EVmHL/GkNBeqsQYDXSBxnhZ4P6mUVsixxeUir83dfw5RRZ7DFvYCMzLvYEf8+R+79VN3epHg+KLKn/1MfmY9JeI0dFxzHx7HVUQUNtmGOQ/gK8yck0dmwx2+iMP7XWP0ZApTJmIGzZFNSM+ATYWI2WPFQmTwINl7AMah4gh8UjokxbImaB13REmLFgTbFFFIG+SgTr98dvv7KbB3pUH2Y90kDQkp1MeInvyexFJO++v6MHNMdp77POV8vVvfKcocsXAZ1NNY5wUCbStArOieNyujKyUEB07LCzqB+ZiRLUG6WZ53VDxfE7LmBo02d3eLSuErTHLcdVOMk/o922v+BjxHXvGF4ytKpU1IZnagmXbioOP9zDNP5/M75CqKBKEMt94WwxufTq+PLjRNuaV8sRJEEBqnqS9W6nTl++v+kjsF61pnPc5xR/IxvhrQUprG1vk7NoMB+1klOWtL+dJFYlq1Hr9u7f1r3iwX6K2mWG9tpU2oV9Sa+uR2Syvrujpkj7f2nliUX8Li5MdEPWf+WqZaA== +sidebar_class_name: "post api-method" +info_path: en/release-management-api/code-push/api-reference/release-management-api-codepush +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Rollback to the previous, or to a specific version if specified. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/sidebar.ts b/docs/release-management-api/code-push/api-reference/sidebar.ts new file mode 100644 index 00000000..00ba601e --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/sidebar.ts @@ -0,0 +1,144 @@ +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; + +const sidebar: SidebarsConfig = { + apisidebar: [ + { + type: "doc", + id: "release-management-api/code-push/api-reference/release-management-api-codepush", + }, + { + type: "category", + label: "Deployments", + items: [ + { + type: "doc", + id: "release-management-api/code-push/api-reference/list-code-push-deployments", + label: "List deployments", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/code-push/api-reference/create-code-push-deployment", + label: "Create a deployment", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/code-push/api-reference/delete-deployment", + label: "Delete a deployment", + className: "api-method delete", + }, + { + type: "doc", + id: "release-management-api/code-push/api-reference/get-code-push-deployment", + label: "Get a deployment", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/code-push/api-reference/update-code-push-deployment", + label: "Update a deployment", + className: "api-method patch", + }, + { + type: "doc", + id: "release-management-api/code-push/api-reference/promote-code-push-package", + label: "Promote a package", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/code-push/api-reference/rollback-code-push-package", + label: "Rollback to the previous or a specific version", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Updates", + items: [ + { + type: "doc", + id: "release-management-api/code-push/api-reference/list-code-push-updates", + label: "List updates", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/code-push/api-reference/delete-update", + label: "Delete an update", + className: "api-method delete", + }, + { + type: "doc", + id: "release-management-api/code-push/api-reference/get-code-push-update", + label: "Get an update", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/code-push/api-reference/patch-code-push-update", + label: "Patche an update", + className: "api-method patch", + }, + { + type: "doc", + id: "release-management-api/code-push/api-reference/get-code-push-update-status", + label: "Get the status of an update", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/code-push/api-reference/get-code-push-update-upload-url", + label: "Generate an upload url for an update", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/code-push/api-reference/delete-code-push-staged-rollout-schedule", + label: "Delete staged rollout schedule", + className: "api-method delete", + }, + { + type: "doc", + id: "release-management-api/code-push/api-reference/get-code-push-staged-rollout-schedule", + label: "Get staged rollout schedule", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/code-push/api-reference/create-code-push-staged-rollout-schedule", + label: "Create staged rollout schedule", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/code-push/api-reference/pause-code-push-staged-rollout-schedule", + label: "Pause staged rollout schedule", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/code-push/api-reference/resume-code-push-staged-rollout-schedule", + label: "Resume staged rollout schedule", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Metrics", + items: [ + { + type: "doc", + id: "release-management-api/code-push/api-reference/get-code-push-metrics", + label: "Get workspace level metrics", + className: "api-method get", + }, + ], + }, + ], +}; + +export default sidebar.apisidebar; diff --git a/docs/release-management-api/code-push/api-reference/update-code-push-deployment.ParamsDetails.json b/docs/release-management-api/code-push/api-reference/update-code-push-deployment.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/update-code-push-deployment.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/update-code-push-deployment.RequestSchema.json b/docs/release-management-api/code-push/api-reference/update-code-push-deployment.RequestSchema.json new file mode 100644 index 00000000..11b3fab9 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/update-code-push-deployment.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The new name of the deployment"}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/update-code-push-deployment.StatusCodes.json b/docs/release-management-api/code-push/api-reference/update-code-push-deployment.StatusCodes.json new file mode 100644 index 00000000..a48282b2 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/update-code-push-deployment.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Update deployment","content":{"application/json":{"examples":{"201 - Update deployment":{"value":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"New deployment name","created_at":"2025-02-11T09:26:01.000Z","updated_at":"2025-02-11T09:26:01.000Z","number_of_updates":0,"key":"random_generated_base64_key"}}}}}},"400":{"description":"Bad request - The name is required","content":{"application/json":{"examples":{"400 - Bad request - The provided deployment id is invalid":{"value":{"code":"ERR_INVALID_UUID","message":"the provided uuid is invalid"}},"400 - Bad request - The name is required":{"value":{"code":"ERR_VALIDATION","message":"name is required"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/code-push/api-reference/update-code-push-deployment.api.mdx b/docs/release-management-api/code-push/api-reference/update-code-push-deployment.api.mdx new file mode 100644 index 00000000..2fe392f9 --- /dev/null +++ b/docs/release-management-api/code-push/api-reference/update-code-push-deployment.api.mdx @@ -0,0 +1,69 @@ +--- +id: update-code-push-deployment +title: "Update a deployment" +description: "Updates a deployment." +sidebar_label: "Update a deployment" +hide_title: true +hide_table_of_contents: true +api: eJyVVm1v4kYQ/isrS1XaCAMmbz10uROXcD3UhIsIROrlEFrsAe9he93dNQlFfO0P6E/sL+nM2rwFSJV8IGvvzswzz8w+47kTgPaVSI2QiVN3emnADWjGWQBpJGcxJKbslBwNfqaEmTn1x7lj5ATw8GN/0S85ho81rp3r1Xnt4GuZguLktBWs3F7JAO4yHa6PoueUKx6DAaWt7wQf0EAEuCUIUcpNiGsFf2ZCATozKgME5IcQc6eOaGYpWWijRDJ2FoRJgU5lokHTfq3q0b99eW4kiSF8mRha4WGeppHwLf7KD00WcweeeZxGK5/MZbtOcGvKowxoIShxr3YCp2fnFy78+m7oerXgxOX47J7Wzs+9U+/itFqtYugi6zY8bXhj9i3iUoBhggFH/xi5duZWa67ndavv6rXzetUro49veC6zcP7/XJLFQ1ADORrkFphRteRMAIvrKJ4EMh6MIaHyobMh13B+OqDdhf0rOYh5l9BPPGBUI9AGmemGYNEzodmqcm9iGIOgn12vqZJTEUCwyZMIKI5IkHoifaMGPnYcgmt2OoNW+6Fx07oe9Hqta4QSg9Z8TJtm02uWbTsr8t0LZSfBA5Ft3Ea39bW9FXfHfM3vvoZNeGZCqcRfb2fS9uqm/QGgvXaj1/3ytdP61tymaMt4DfNkF+YdqFhojQ9YoES8HesJYt11cgDwXbNz27q/R2YH18126wXqXTdL6Gf7OriFKFXCI3YPagqKNZWS6m3wz2yn7Hd0sC27zU67cbOF/F6iIoYoZ+yJ+vtJSatsBfqiCz/JYJY7exXfjlDK4Q/wrfIqEmkjcuy5BL2U09ILkmzfo0rZ5pUjRpdnQ/+WEAm+DHL19kOr8qjidaeyPqsrcxEs7GghlnL1z1SEp+YkOr3OzaKiIAJcuzFPkBkyq0xrFaLPTXGQVKYeOphyJfiwKEFhmpd3xLOIxDA0JtX1SoWnojwUmJmGspB7k8vRMHLD0A97Eia0WVoeoUwp9tfz8N6+tZGLqbhiEIP9jqpZjLEQeABqJ+Rdo4t8+lR5NWNGsgzjNu5azOdRpNeTYXn/bG2tKlF9O+tOaOZtuK7kaiASgJG0wIShE04nZ5Xdrli1IV22HNBEKpYkhzitlb0d3MfHN1JOqENHUll+ZBSQl4/Hx+wPmSH+hI1EgmJqWAgK6uw9Z6GC0eXRvqoiWW4gfV1BE3guhyaOPmIz6HKqRIzUtDGnywL3T7XqGjk+YFT8ffDw5xpdHDHD1RjM5dFgGPFkcvThwbP56RT89xX+4XvyPemuEWOJo4gNbR8r8GnqMZSMzzBUGRXFQ8HHaXpRRr4m2AeZAkyYGzbDNEM+BRaLsR2WVD9TXBByPAQkhw5DUqagrzKQO0F23THOILAU7ElFoG+KgTn9+/c/7KHGbpeG7DcypAyp6KnUBt1vNMS+b7uXhd2Qk4PfgkV/G3g2lTTi2N4Yzt7ceXHPH52Ne44WdZykeGlChESb8/yCq2ixoNfYw4o+LPvrq2zFIBCa1igjIx5peAXpz51ihv7CDuFbXspkZhXDCrHjLD97aNL38VRxSyl6vnGVx3C7ZL423BHaRWlp0fB9SM2rZ/sbAokCcPUFTw8LNY/z0aD4E3304q9FKW3SVmbsu7mD7TDO8mmROyVNIJXYVqCJVaBiYb/d9/GwrS5LUuw3X+mAyXye69tisTqfbx20WClgQTkRgaj/A9iwOuA= +sidebar_class_name: "patch api-method" +info_path: en/release-management-api/code-push/api-reference/release-management-api-codepush +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Updates a deployment. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/cancel-review.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/cancel-review.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/cancel-review.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/cancel-review.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/cancel-review.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/cancel-review.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/cancel-review.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/cancel-review.StatusCodes.json new file mode 100644 index 00000000..148410ca --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/cancel-review.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Cancels the review submission","content":{"application/json":{"examples":{"200 - Cancels the review submission":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - when the store review submission does not exist in App Store":{"value":{"code":"ERR_APP_VERSION_SUBMISSION_DOES_NOT_EXIST","message":"The app version submission doesn't exist."}},"422 - when the app version is not currently under review":{"value":{"code":"ERR_MISSING_REVIEW_ID","message":"Cancellation is not possible. This version was not under review."}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS app versions."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/cancel-review.api.mdx b/docs/release-management-api/store-releases/api-reference/cancel-review.api.mdx new file mode 100644 index 00000000..8c1c207a --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/cancel-review.api.mdx @@ -0,0 +1,69 @@ +--- +id: cancel-review +title: "Cancel App Store review" +description: "Cancels App Store review. - IOS only" +sidebar_label: "Cancel App Store review" +hide_title: true +hide_table_of_contents: true +api: eJyVV2tvGkcU/SujlSq3lgFDElWy8hCNSbqKDXR59JFYaGAv3qmX2c3MLDZFfO0P6E/sL+mZ2eW5ENX5QBZ27rnnvs4dL72Q9ESJ1IhEelfeey4nFGvWTFPWM4kipmgu6LHKKszv9Fgi44V34SUpKW5N/HBjFLiDeKlpkilhFt7V56VnkgcC8Oe71d2FZ/i9xrNn0YekNAA0gPE1ppJLDwYpV3xGBkcdmMQX+BMhvAhLN+UmwrOir5lQBC5GZQQGk4hm3LuC+0VqLbRRQt57K0tCkU7hl7R937i8tP8dT4KJ1lyYzsYzoS1huJsk0pA01pCDupi4VNT+1NZ66dETnyGgNT4C/DYgjs15nIHncuX+XXgvL+tlWgPJMxMlSvxF4fNYAA4s9ux3nAIptElqBcFo0G4O+j93Av+P1jV8zEhrfk+Hzrc0X5RpdkkVkbGQpHg+1xfgWgY5QbjbCm79Xs/vtEfXrbZ/wLoMs6X+skw9oJi4JiYTw6ZJJp9N/SWol0FOUG93+qMPnUF7n3Lf9YhOMjUhNuHSwoypQNqwrzfK7HuGy5CrkIEkocHZZiyeF0W9gShOg52Iptdvtq+bwfXoxn/favdao6D1y8APWofRCY1wJE2FWUNqxsvupoly4wLikiaGQgbe1W0CGkcS4EsQEyFLY25gP3tm3A0b92NE0jnWO1K0M60sTEDYFoWehDZMyK1wnUpNs9sdDVuBa9Le4KdNv3ZaPdcErd/8Xr/UBODL5rlIHvqXZ4V7m5CLQ+a7hiLnCkFWSEO8YOgiUmuFPcHXEWx/RAWHfuvXkb9fwlzMYpfINX6agNw4pipzBV57f+T5612nu5RLBTtByG8Pmzf+9ah70+x/6AS35ZYiGaaJkMYSsjuKZZqDj2sjgb21kxO97aJXx9TfR8coyWPWIwUT1lIqUc9rpVdO9Y8DnQyx3wrazZu90HoJll+EzcUe4Zk9qsQtsYK9fZfY/YvsG+8iX4ZXXg3sKutYa0sRruwvMVXs766ra3klahNXSbexLcF8x2YqBshyDAkbBDcrnHVyVplxCVIz8KjNGzWHUyne6dq8DpQ5V8Im3aWgsM/TO+VZjMR5kTGpvqqBj6iOBXaypqpIYLpfAdv9OSVmYRhw2KMwUT6XdreTq+Hd9q7Rc786z8WNY7P74ewTLdY3hog4erHkstvsM+iMzbxaMJOgf3Aj6fpQ4DjWOF5cPdZL0NXedbKQ08R5EyamnR1yu8mXw3G3nM2lx2Yrf4TFvFGtlwidn98kyYMt/VoJkzi0SO/Oz9nvSWZXA5sKGTIIaUSKrthrziJF0zdnx2qGLFTCZKJrMKGnamRm8TuUWldTJWaIuY343hTcv2tcbtnjC7zic1jHxzUgzpjh6p7Mm7PROOby4eztsO5i1ClNXtf42y/yi+xvGaN2cWx3WEipIowNxBzi8IHGKrPZrkNGG5eNH6vI2QMKnEF3TcQNWyDMiM+JzcS9cmYojE2FhCRb4DFNE3eYZNU6/WYGchBkt3KfiZBcCo6EYuXe+kBM//79Dxs22O3akH20hjZCD4W3Uwd4W/uiOXJlLF9kD2q73ErJ/71vF61s6MnUIJboZBBwk7osxv6ztzv2MLlyt+SDyXd35YJTMf0YosjqBxCW+dSreLWyP3/NSNlL/N12tJ1ChMJpK5RnymNN34ju+6C4NPzATgWxHlK5cArihNHD4wNG1t30V3c4VUyt9Z6/aE4mlJodk5IkW3XYKGS34xasnd59ZXhwylA8uL9XjvHZn/o1Ofu5ujhhslzmuoNUrs/nr05abJSpCN2GAJH7D0YEqEg= +sidebar_class_name: "post api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Cancels App Store review. - IOS only + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/complete-phased-release-ios.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/complete-phased-release-ios.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/complete-phased-release-ios.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/complete-phased-release-ios.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/complete-phased-release-ios.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/complete-phased-release-ios.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/complete-phased-release-ios.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/complete-phased-release-ios.StatusCodes.json new file mode 100644 index 00000000..87154238 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/complete-phased-release-ios.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Complete phased release","content":{"application/json":{"examples":{"204 - Complete phased release":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - when the release version cannot be found on Apple App Store":{"value":{"code":"ERR_APP_STORE_VERSION_NOT_FOUND","message":"The release version is missing from App Store."}},"422 - when the release version is not a phased release":{"value":{"code":"ERR_RELEASE_CANNOT_BE_COMPLETED","message":"The release version you are trying to complete is not a phased release.","details":{"app_store_version":{"app_store_state":"READY_FOR_SALE","release_type":"MANUAL"}}}},"422 - when the phased release is not in progress":{"value":{"code":"ERR_PHASED_RELEASE_CANNOT_BE_COMPLETED","message":"The release version you are trying to complete is not an in progress phased release.","details":{"app_store_version":{"app_store_state":"READY_FOR_SALE","phased_release_state":"COMPLETE"}}}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/complete-phased-release-ios.api.mdx b/docs/release-management-api/store-releases/api-reference/complete-phased-release-ios.api.mdx new file mode 100644 index 00000000..adf84714 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/complete-phased-release-ios.api.mdx @@ -0,0 +1,69 @@ +--- +id: complete-phased-release-ios +title: "Complete an in-progress Apple App Store phased release, releasing to 100% of users. - iOS only" +description: "Complete a phased release, making the update available to 100% of users immediately" +sidebar_label: "Complete an in-progress Apple App Store phased release, releasing to 100% of users. - iOS only" +hide_title: true +hide_table_of_contents: true +api: eJy1V9tu20YQ/ZUFgcCtoXtSFDByARsxjVBZUiXZQJoYwlpcmVtTXGZ3KVsV9NoP6Cf2S3pmRepqpvBD/CDzsjNz5szO2eHKC4WZaplaqRLvwnuv5mksrGCcpRE3ImRaxAIXFTbn9zK5YzYSLEtDTmsWXMb8NhbMKtZsNF4wNWOZEdowOZ+LUGJRvPQqnhHTTEu79C4+rzyr7gVCfb5Z31Q8y+8Mrj0/Tdk1DIHCsCrDLbzSw5FVWrDhBoQHC5UKzQltJ9zDO3Bg82Wd/ghBU675HK+0cWET3MBAhnglKdWU2wjXWnzNpBZwZnUmgHUaiTn3LgB0mZKFsRp5e2uCq4VJgVAYet9qvKJ/JQQe0odAU5VYkVgy4UhPTl0W9T8N2a088cjJsvAMEspcYcGCxxldrN1fxXvVaJ5CuUp4ZiOl5V8ifF58uEP8A/u9oPAUEjHBcDi56vlX44/9YeePoI0Yc2EMvxPHwXcwX57CHAg9l4Yqz0KRyOdjfQmsp05KAA+C4WVnNOr0e5N20OscoT51s4P+RLHz/cYSZdlMZcmzoVOZT52UQO/1x5MP/aveIeQx+hHbUmV6KtiUJ+TmVuSetuibrVP0I8uTkOuQAaTApmbbVnheFs0Wsih3VpLNaOz32v6wPel23ge9UTAZBr9fdYbBcXbSIJ1EzKQtXBqI00m4mdJOmgA8EVOLdgHu2o6A1hMEdBIAkyFLY25hP39m3i3K+yESiQucdydbbFTsuBQMj45UrYwZfzAAO/1hMLkOhm6nfqvyh1HBltvAEOqZVvNdMKKi8n+YYU2Yj7W/DOgw6AY+Kvfe7xHCX3DVvxx0g/FJEU9DLVXGOJTd6qU7VRQql8tdCYoafIbC4sgxeXkmhjKb5C4PHxqLw4daNPDbn0AeNpzfDZzeO2+TXN0v/d6V3/W2u2SfnsP4BS6ZsFSrO+xDUyoyH0FL+3vzk+xD+T5kbZxOCs6KdUUaB7SddFMJOZ3etd/ttCeDrj9GqMvTfhdJmCqZWMpUJfESM4WbMqjHZX9U5Gh27f1To/FUe+PwT3jMRkIjbRZorfTzehx+XWZPOSpNbxwMe9hS+2mNFCaRiAr5gMjsQSs3UeTo6Z2iaSZVxrrJBZPJhVcHumpeL1NfyXBNT2JRpeeucPWciXqxN9ysRRg3M0+mY/hZ3WLJ1bC7LpZX5zwBrjmg1BetunNVLUitL5rwsuBaEueOhdx+w/CMZzG48yJrU3NRByRZu5WYkbDppHLbbr8ItLc3kBi5YfDDHqSNXIO5WctJEw1XxZQ4ck9d5HxW3M5iCPabWBYTXCR4KPRJyIE/ZjgDiHy9pM7BSMr8QQeSHKMdKsUoWAworvxOHmUyUy6atLHYO98vt3w5P24+3Y6rxFbRVN6iVWueADo/7yrlhufilFJxSJ7enZ+zT2h0nBVsJnFI4JCLhBYX7DVnkRazN2dP1QwsVEM1NXWYiMdaZOfxO5Ta1FIt58i5h/ze5NhftBo79LhBVPxeN/HThoszZrm+E/bN2eQ25sn92dvrpsvRpGL6us7ffkm+JOMdYtQujulQC0WqBTpHuJPtg7jVGbHdNJa1Gq2fa+DsHgXOSMIibp2eRXwhcDzdaWeGwhAViXhwjm/FTLnFIqlR0G8ysHECdqt3mQyFo+CJVCR8Uwzk9O/f/7DrFrssDNmvZEgZeig8NR7cU+3zzVEM32ajs9Wtzh5/mhx/Jm0ucs0++CiqYeOQfJGkHe+R1U6VvtM3WN5BVjzaOiQaDYS8nUCscsH57O0LDkwu3MfSkebsjlAnpbnuoH0jEi84WW30RsfrNT3+mglNH343O1Fx2hRKJ+qQvRmPkVs5Hz8M81HyR1aWRyEPydJpl1NlD5f3EAv3zbe+wapcLyj65oU/nYrU7pmcnAekS1t5HvRHYyIkI7b2NeneaVJ+4b5xn8JzqDcFOPpdV0pMVquN4oHKYv3mVanFVhPz1CkFyOt/xeVwbw== +sidebar_class_name: "post api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Complete a phased release, making the update available to 100% of users immediately + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/continue-phased-release-ios.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/continue-phased-release-ios.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/continue-phased-release-ios.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/continue-phased-release-ios.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/continue-phased-release-ios.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/continue-phased-release-ios.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/continue-phased-release-ios.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/continue-phased-release-ios.StatusCodes.json new file mode 100644 index 00000000..c7972c1d --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/continue-phased-release-ios.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Continue phased release","content":{"application/json":{"examples":{"204 - Continue phased release":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - when the release version cannot be found on Apple App Store":{"value":{"code":"ERR_APP_STORE_VERSION_NOT_FOUND","message":"The release version is missing from App Store."}},"422 - when the release version is not a phased release":{"value":{"code":"ERR_RELEASE_CANNOT_BE_CONTINUED","message":"The release version you are trying to pause is not a phased release.","details":{"app_store_version":{"app_store_state":"PENDING_DEVELOPER_RELEASE","release_type":"MANUAL"}}}},"422 - when the phased release version is not paused":{"value":{"code":"ERR_PHASED_RELEASE_CANNOT_BE_CONTINUED","message":"The release version you are trying to continue is not a paused phased release.","details":{"app_store_version":{"app_store_state":"PENDING_DEVELOPER_RELEASE","phased_release_state":"ACTIVE"}}}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/continue-phased-release-ios.api.mdx b/docs/release-management-api/store-releases/api-reference/continue-phased-release-ios.api.mdx new file mode 100644 index 00000000..f714f3bc --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/continue-phased-release-ios.api.mdx @@ -0,0 +1,69 @@ +--- +id: continue-phased-release-ios +title: "Continue a previously paused Apple App Store phased release. - iOS only" +description: "Continue a previously paused phased release" +sidebar_label: "Continue a previously paused Apple App Store phased release. - iOS only" +hide_title: true +hide_table_of_contents: true +api: eJytV21v4kYQ/isrS1XaKIHAXVUJ3Yvc4LtaJYaaF6m9i9CCh3gbs/btrslRxNf+gP7E/pLOLDYQDKmQLh8cY3tmnnlm59nZlROBniqRGZFKp+XcptIImQPjLFOwEGmukyXLeK4hYlnM6Z+CBPDGuXI0THMlzNJpfVo5Jn0EdPHpfn1/5Rj+oPHecbOMjUBp9K7ZNcOfCdCV9U2qgIWFK7RIM1CcUPjRHo6eDVl85nf7GDTjis/BoFMbVuIPNBARvhKUQsZNjPcKvuRCATozKgfEOo1hzp0WAl1mZKGNEvLBWRNcBTpDhKDpffPmNf07QUyFhCm+AWnIhGN6YmqzqP+pyW7lwFc+x6RLz0jCKVf4wYInOd2s7d+V8/qmUYUylDw3carEXxCdFx/dYfxn9ntB0VNExHhhOB4G7nDwSzf0//DaGGMOWvMHOAy+g/mqCrMHai40VZ5FIMX5WF8h1qqTE4B7Xnjn9/t+Nxi3vcA/QF11s4N+pNjFemMyNWyW5vJs6FTmqpMT0IPuYPyhOwyeQx7EgCtDp7maAptySW4mUHjaom80q+j7hsuIq4ghSMBFzbatcF4WjSZmcdrZiWz6Azdou2F73PFvvaDvjUPvt6EfeofZCY3pSJgJU7rUKDqVcLNUMYNUIHAJU4PtgrhrOwKaRwjwJQITqFcJN2g/PzPvJuX9FIO0gYvuZIuNih2WguGjA1U7xYzb6yE73dAbj7zQrtSXKv88KrJlF7B8YDOVznfBiIqr/8OM1oSZv6A4+0BDr+O5WLlbNyCEP+NdNxj4wbBSxGqoZZozjspu1JLAmnSzeZyCUEOHERguEl3UZqwprXHh7/lDbbix7ewFbT/4iJ0+8jpdbP0SstV963hcqPydGwzdjrNdLfs0PYdyyNZm0zupN79guPY3pmpa7gw7to7tvN+etI3/ccldaeLeDvyR94y8Sm+d4McPRm7Hb497HXfwoRveVbsfZJSlQhpKNpU4ZeSaT5JNx4tuv0xW75r9x5ubY82Oo4DkCeuDwvyZp1Sqzut49GszO+boZHoDLwxwYe2n1U9xLomplk8YmT2p1M4XBXp6l9Jsk6Xa2DkG55SWU0d010XhdH0lojU9SeCantsK1gsm6uXysJMXYdxMQLlK0M9qgp8Mw866/Px6ziXimiOU+qJZt66uS1LriwZ6WXAliHPLQmG/YXjG8wS5c2JjMt2qIyRRmwicmHD1idSuv/0i0PLeQGLkhqEf9iRMbNvMTl5WqGjUKmfGvn1qIxeT43Yyw2C/wrKc52LgEahKyJ47YLgjEPlqSc1DKuP2fBToBPviqhwMy3HFlt+KpZCz1EYTJoG93f5uy5f1Y6fV7fBKbJXd5SyatUYF0OVlJ00frUIXe1aaROTp/eUl+x17HXcONhO4ZeCWF4OCFnvDWaxg9vbiWM2Qhesoneo6msDXWmzmyXssta5lSswx5wDze1tg/655s0OPPzAqXkcNvLTRxQUzXD2AeXsxniRcPl68GzVsjjqD6Zs6f/dZfpaDHWKsXZLQFhcBngKwc8Ducx9gonJiu6ENa940f6ohZ49Y4JxULObGSlrMF4Cb1YOyZlgYokLCk3U8gVlqPwZZo6AvMrBxguxeP+QiAkvBkVQE+qYYmNO/f//DRk12Vxqyj2RIGTpYeGo8dE+1LxZHOYrro+edw9PKgQrjCiGdIu06XAyrnfyceaQqWsDAV1NHjcUOQOC2w1eFYnxy9hUDTVr27HMgGrudsNBCKxzYfzGpDzpZbQRDJes1Pf6Sg6Jz3P1OFay4RMKqMurWjCcaXsjz+7CYDH9gp/Io+1surfhYWXXw9hG73R7h1vf4VdHwFH3zwp1OITN7JhVBJ2HZ6muv2x8QITmxtS8qj1ZUiht7ZD2G57lglODour46YbJabSQLqSy/37w6abEVtSJ1SgH18T+8fFLc +sidebar_class_name: "post api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Continue a previously paused phased release + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-approval-task.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/create-approval-task.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-approval-task.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-approval-task.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/create-approval-task.RequestSchema.json new file mode 100644 index 00000000..a4044ff2 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-approval-task.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"assigned_user_slug":{"type":"string","description":"The user's slug to assign the approval task to."},"description":{"type":"string","description":"The description for your approval task."},"due_date":{"type":"string","description":"A valid date in the future."},"summary":{"type":"string","description":"The name of your approval task."}},"required":["name"]}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-approval-task.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/create-approval-task.StatusCodes.json new file mode 100644 index 00000000..7106620d --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-approval-task.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"The created approval task","content":{"application/json":{"examples":{"201 - The created approval task":{"value":{"description":"Example Description","due_date":"2075-02-11T09:26:01.000Z","completed":false,"completed_at":null,"created_at":"2025-02-11T09:26:01.000Z","id":132,"summary":"Example approval task","assigned_user":{"avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png","email":"fry@bitrise.io","username":"fry","slug":"1be8af187e0f2f00"},"creator_user":{"avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png","email":"default-user@example.com","username":"default-user","slug":"default-user-slug"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Bad request","content":{"application/json":{"examples":{"422 - Bad request":{"value":{"code":"ERR_UNPROCESSABLE_ENTITY","message":"Validation failed: Summary can't be blank"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-approval-task.api.mdx b/docs/release-management-api/store-releases/api-reference/create-approval-task.api.mdx new file mode 100644 index 00000000..0c9b29a5 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-approval-task.api.mdx @@ -0,0 +1,69 @@ +--- +id: create-approval-task +title: "Create an approval task" +description: "Creates an approval task under the given app version." +sidebar_label: "Create an approval task" +hide_title: true +hide_table_of_contents: true +api: eJzFWG1z2kYQ/is3mum49VgSyE6TMnkjNkmZOtgF7JnE8TCHtIKLhU69O+EQhq/9Af2J/SXdPQkQBtK4X5oPiri7fe7Zvb1nV547EehQicwImToN51QBN6AZTxnPMiWnPGGG6zuWpxEoZsbARmIKdpZNQWk085wjR0OYK2FmTuNm7hh5Bwh2c7u4PXIMH2l8d5pocF0YaOayZomuHVwjM1CcGLSjFYflgj7ujhtkXPEJGASwW6T4A5eKCKcEEc+4GeO7gj9yoQBhjMoBeYVjmHCngaRmGVloo0Q6chZETYHOkA1omg9qdfpvMxx99De0dKLNeOBWoUwNpIaMcCoRofXA/6zJcu7AFz7JkhU2urwfDJfgew7bBFoFCjurjB45UQ6DCHFwQVB7+sStBW693q/90gh+btTqXq1W+2gJkqmhYMQYaKiMDDjyTvMkwbGCkR1BtGAfGoa6UT8OMKT5ZMLVrELuYWS41mKUImauQdn4TLnhapCrBK3GxmS64ftDgUehwc3yIQbPLcPpIlSUh+Sop489PuFfZcrvtYfcfcJzBa7UfgHpRhDzPDFehmd65OBRC9oiVrPXJbwnJE6QYZkyOEf5muQj/FEfwjMe1589hVocxLWasygDItX/Rr4cdWn96zKLCGDTjeqqtT/VUdeOLYp/R87Jrvy+SnluxlKJrxA9LqVPbEpv2FezOJQRsWx1u4OrTvOq/+tFt/2xdYZ7TEBrPoKHm69pHm/TvAQ1EZqkg0WQisdzPUau2yB7CF+2uu/bvV77ojM4a3XaD1hvw6ypn2xT70ICXANLpWGxRBV9LPUTpL4Nsod656I/eHtx1dmkTMKDWidzFaIC8ZRghlAirdjXg232PcPTiKuIIUlApWQrfX2cF/UAvdgPtsebXr/ZOWt2zwbn7dNWp9cadFu/X7W7rYfeCY3upBALs4TEAra9XSyLAobEUwhLFfbWAQh2BOANjywmaPNIlwNyuWq+93pcdi9OW71e8815a9Dq9Nv9Dxv+XfNERHYjFqNCQNRgvUKC6SwP7FEOE57erTx5gkK25UkbqaN4JKwHCgs3aykl1eN8Qlz0aTfQHu/anX6r22meb3jUk1jJx1iG2T3uzO6VTCtCVcbrjYxmBdg3+W0VeDn8jIdLHYOitsKIgvtGTRoUcvmwKTjaUf1p+YFmZMCMZAWMTaPN/shIj4rHBsD34FdGbILO8JZuQhe4q4r/b6BNNqWEYbSaiYJqnJtcgQVaVe/vIUe1hsl4N6lFtdu6KTqy2+II6XgltXKZtPfGNmcNx0cIt2watT8X0cLnqzaQekjKp6K/K6rtfIiqd9U9X/iqUEB3wlPMoQkmhD8NfI11GtxyTvvTOqJMuRJ8WGZsaV/cBlsaKzWcZ8Lb6BK2A1BQYgTDEIfdCzO2EbVpB1Y8btfdb8+O2p3LHngVZdzsN5gtu9Ux8MjW7Qd1rtlnKE10UfB2Y7ph9rHmZRsvemJDVBb/Zd20V8GeBF2H7vrilJ3ZvsTfd+br4XWDuRpb933LHpqciaV1UhjabVXt3q+OydK37f6q+6dDKl7RYhp49S0eh4fnUt6RQCw1WyYRIb06PGQfZE7Cx2KRRgwlfwwKGuw5Z2MF8YuDXamCwXcjGWofTeCLNzaT5BVmmPYyJcinDob1Rcn9h6C2Zo8/cFd8XtfxcYYQB5j+agTmxcHAiu7By+u69VFnED73+ctP6ae0v2aMKZMkJNERZApC2/zjVX8LQ5XTIde1Ydh1P/UwZneYV3hP0WFu6M6xMZ8Cm4iRsmaYDxSKFO4t8BAwOLQYUo82/WYEChCMrjvKRQQ2BDtcEYhNe6BPf//5F7sO2PulIXtHhuQhHTxdbISnsy9zct+X48PDrSj6f/7aLO+UgS/GzxKOVwopWcmYl1pz41S1Bk0a9lORV786xyROuHJeyIxKFgsaxktEWX5zu9YSK0mR0PS+/pra69aP3VIXf2L7yC5VIZ1ZybKF08HXO5gVn7WLW1xVygTtXkyclt8ZfTJfG24VxsXR0qIZhpCZb669rQj25UWvj4uHZfGdFJVc8Xv6tsanJSmtz1bm7NjcwfQZ5UVxLzBJk0ilNhXwzipg+WL/UrArDJvqtowJPcmtnSbzeaGveILL9cXUXouVApcRpzgg638ANd3d3A== +sidebar_class_name: "post api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Creates an approval task under the given app version. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-outgoing-webhook.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/create-outgoing-webhook.ParamsDetails.json new file mode 100644 index 00000000..6f79a435 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-outgoing-webhook.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"description":"The UUIDv4 identifier of the app version.","schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-outgoing-webhook.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/create-outgoing-webhook.RequestSchema.json new file mode 100644 index 00000000..bc451ccf --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-outgoing-webhook.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed","app_store_release_cancelled","app_store_release_completed","app_store_release_started","app_store_review_approved","app_store_review_cancelled","app_store_review_rejected","app_store_review_submitted","app_store_version_created","app_store_version_updated","app_version_added","approval_task_added","approval_task_changed","approval_task_completed","approval_task_deleted","approval_task_reopened","approval_tasks_completed","auto-upload_disabled","auto-upload_enabled","automation_added","automation_removed","google_play_automated_rollout_cancelled","google_play_automated_rollout_configured","google_play_automated_rollout_paused","google_play_automated_rollout_resumed","google_play_release_completed","google_play_release_notes_localization_added","google_play_release_notes_localization_changed","google_play_release_notes_localization_removed","google_play_release_started","google_play_rollout_percentage_changed","google_play_testing_track_release_completed","google_play_testing_track_release_failed","google_play_upload_completed","google_play_upload_failed","google_play_upload_started","metadata_localization_added","metadata_localization_changed","metadata_localization_removed","microsoft_teams_connection_changed","outgoing_webhook_added","outgoing_webhook_deleted","outgoing_webhook_updated","phased_release_disabled","phased_release_enabled","phased_release_paused","phased_release_resumed","release_candidate_auto_select_latest_build_disabled","release_candidate_auto_select_latest_build_enabled","release_candidate_build_selected","release_candidate_source_changed","release_description_changed","release_settings_changed","slack_connection_changed","stopped_managing_release","testflight_app_review_approved","testflight_app_review_rejected","testflight_app_review_submitted","testflight_distribution_start_failed","testflight_distribution_started","testflight_distribution_stopped","testflight_processing_completed","testflight_processing_failed","testflight_upload_completed","testflight_upload_failed","testflight_upload_started","testflight_what_to_test_added","testflight_what_to_test_changed","testflight_what_to_test_deleted"]},"description":"A list of event names that will trigger this webhook. These events correspond to specific actions or states in the release process."},"all_events":{"type":"boolean","description":"Indicates whether this webhook should be triggered for all events. Set to true to enable the webhook for every event."},"webhook_configuration_id":{"type":"string","description":"The unique identifier of the webhook configuration that can be found in the workspace integration settings."}},"required":["webhook_configuration_id"]}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-outgoing-webhook.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/create-outgoing-webhook.StatusCodes.json new file mode 100644 index 00000000..22eee025 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-outgoing-webhook.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"The created outgoing webhook","content":{"application/json":{"examples":{"201 - The created outgoing webhook":{"value":{"id":"921db057-73eb-418a-b7ed-04f451e9dd85","created_at":"2025-02-11T09:26:01.000Z","events":null,"all_events":true,"webhook_configuration_id":"5623239f-28ea-4b8d-856e-8cb50073fade"}}}}}},"400":{"description":"Webhook configuration is not associated with the workspace of the app version","content":{"application/json":{"examples":{"400 - Missing parameters":{"value":{"code":"ERR_MISSING_REQUIRED_PARAMS","message":"There are missing params in the request: one of all_events or events must be present."}},"400 - Webhook configuration is not associated with the workspace of the app version":{"value":{"code":"ERR_INVALID_WEBHOOK_CONFIGURATION","message":"The given webhook configuration is not registered on the workspace."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Webhook configuration does not exist":{"value":{"code":"ERR_NOT_FOUND","message":"Webhook configuration does not exist."}},"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The app version cannot be found."}}}}}},"409":{"description":"Webhook configuration duplication","content":{"application/json":{"examples":{"409 - Webhook configuration duplication":{"value":{"code":"ERR_DUPLICATED_WEBHOOK_CONFIGURATION","message":"A webhook configuration with id: 5623239f-28ea-4b8d-856e-8cb50073fade already exists."}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-outgoing-webhook.api.mdx b/docs/release-management-api/store-releases/api-reference/create-outgoing-webhook.api.mdx new file mode 100644 index 00000000..85142d13 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-outgoing-webhook.api.mdx @@ -0,0 +1,69 @@ +--- +id: create-outgoing-webhook +title: "Create an outgoing webhook" +description: "Creates an outgoing webhook associated with the given app version." +sidebar_label: "Create an outgoing webhook" +hide_title: true +hide_table_of_contents: true +api: eJytWf1u2zgSfxVCwKF3RfyZpEmM7S68jds1NnFyjtPFbTcQaIm22ciijqScZoP8ew9wj3hPcjMkZUmWlMbAFqjrksPhbz45M37yQqYCyRPNRewNvA+SUc0UoTERqV4KHi/JA5uvhLgnVCkRcNgOyQPXK6JXjCz5hsWEJgnZMKmAR9s78BQLUsn1ozf48uRpcc+A85e757sDT9Olgu/eEA58tgeUB+siYZIihHG4BXHl7v/NXg98Eyrpmmk4ZzjH8B+g5iFscQSfUL2C75L9O+WSASctU3awI+EMUN/ejs83R4SHLNZ8wZkkYmHE2RUkWLE19QYgxWOCdyktAZH3jLJIphKAzxTu97s9/Kd6VWBkCSvaBO6BiDUAwHNwb8QDo4HOV4WHnzz2ja6TaMuetMiL/IBqQ6OU4ReOWjzr98J59/ikdXLI5q2j3iltzU9Y2OoeLY6Oe+wsDE+PEYVl6FMAAvf0j1vdfqvXm3XPBv13g26v3e12fwc6BobWACZOo+jAo1HkZytWyw6HD1It+DK15vQNkuN3/cP+4dmi1T9ltHU0Pw1bp8fvWOs0mB93uyeHCxoy0Cn+OfCOut2qJp0PkBJzwhWJha71ywch71VCA1Zj2f1UD3hA9ZdcKdR20QULCg9EiO4xmk79y/HNzXjyyZ+O/nk7no7O/evhdHh5A5eumVJ0yaxjSIAEf9dFvorw2IBFD2ZKD4iIjQC5tomQxH1bp0qTOSMJOCIstD2nPUD716qrQdDx5PPwYnzu/zb6+Zerq1/9D1eTj+NPt9PhbHw12RXXJYqHl4BJtuQKVIveHZdhtQvuURNotzFN9UpI/icL97UuBlbpfIO4t5Ph7eyXq+n499F5SbrS4RzmYRXmNZPG3iAdZB6+P9ZDwFpl0gD4ejQ1vng18c9Hk/EO6iqbHPpRFfqURYwqZuy0EGm8N/SjRrcMBbP2Z9/A/E3STK5m/ser20lZitdwzAIDEVTF2Ou6WTkySEBj5ARBaJgVvfTstUksTLeq21enZ806LTBtkPD89vpi/GE4G70mgocNkWsSCA8H5DUpHtIYvDXhozWLKmir169q60bTOKQyJCAIg2eWbJ/1/bTU64OWmpk1aOdmNpycD6fnPuhoNLkZbdP5jj9A6pqzmC24zlhC7VS9bgFpGxMaAI9ZgKkXcOcKOK5788Ygo4xpRG6YBIcjIymF3E/4Y/Ma1DNqzOqz0XQyvCjJeSPgzVvZaiPW5EEKUwQ59O61+lmEj5bZi/gqNZWYfwWVYHknsQzU3GLPqostHZWSPmKpp9m6uO5qMqhQ4nSNxaW0Qe5DdIY8hIfOVwz5Q12rFxFfrrQP4SFo6C94zNXKuNRSiGXE/CSij77SQrIamjnT1Jdsw9mDD6JJsaksS/bV2NeUoRYG2B6pgTl8Ot4IBUD7SynSpEALFVMVSEasJQ2wbrRX00hBrYWmttepdL7mGis5vNDCMZwNLtBFwKLIATNLSlOdAo8VjZclwLAhyyKAWcCPoXhnNeRFELmEBSNsL67ZffFsDqS4t6v+yl7TlbsGquxtVVjadMned4Vy7V6ahIW9bJWGYbZmDOZrqu4bVnO97qyXNVTYCVn9umQQRnF1o+wuULOIlnPxkCs6jyrLLC6urm1Bv0WfL0m2dqYo+q4jAH+UIoqgXSnZ5TuU7pF5BWlCU/UKMsjL6bpCV+eGdfvwyDPlRyKgEf+zrIdXkufmfeWBeqVWI6O0m+mkLlyLhKWM8l0t1FMvKK+a0nlOE6cspb5wNJcMnhwKUUXr9V6/m4tbv59rdc0DKZRYaBAPOi/fvcxlJlmT7WfNbXZ7ZSMPxspWnhuSFSgu3GqwEHY7O3nk7WxsvX1nPXfv6uOHwQAvYATS+REOd7Q/T3lUCvs9TuXYqocshT3VQKJECs5Z84wUip+6N4lp9MHic6UidMdau0FyThJQz5rGdIm2cGzKRQCm6upzUk9QeDbqCYpvR4ECdAzlyTw1AI1v597/Itl3KIx8ZQqQIGBmmlCKv3qKOhA1wVtTMjUfrMX9sKIQYsIkkW34NO3nFmyiyOLs7nl3rjeEYltpnF+YypHgdFBB0U2hXuVRREB7yyXDMhxqdhebbRypQXnuJiqBkHaoFxItiEpYwBc8INS4lxm9YM3ECmMa2006vUI9Xx6MbUvUuRBAif3dbokfYnkMHB9WUGDvoCNqJdIoxPbSgYe+ATsJuMNBbkNNrxEszuDwXxuddnjiuCzsyEg+2jMGZfOwrlpWV2eaacyh4q8Zn9Y3icYGkAG2fXKmv3zqxKFlWDryLNRt3543al+aUd/ZRgSbFIEDx0Qo01DgPHjgdSBMW64mU50nHj53siTdciyVmVpjd2RHy6mM4ODTHKx7O7147jhLt0xCYWuQu7Ppd0wN2HJ7qrPpAZcNlRxNYMzvztvebkHTCGesK60TNegAKt6ec9CyYm0uahVtIRFkQ4BPPq8zTZSdit3l8/Ybs2odz07d8+Yp4b+yx2xQvoI2nMnKldfDGYFkim0feAt4Ezw2ZHg9BuNFEarITdyzeZedL6Dmsbmb5m3gyPagxTauqS2723OWnE3gUZKFMBJyjVdtR1SXWxsZ7C1S+rEBLJSNNb1Nv92rKOHt2wu4GnvdrGkXEIPA6ae3b8m/RGo8GZpC8GJNcI47ID9QspJs8f5NnZ+A5luhCFQHjrBv7ZVeRz+Be6l2Ivka9DwBnb532P/W7+bo4T9wK3x+7sHHObB4QyDDLpl+/8afRzS+f/Pj556REVPVDx364x/xH/EsR2wTH0RdyBLJAvu7QUw+srlM0cI9yJf9bv+kDTq7B6eCgtsG6yOIuaIbHE9jVDKTD1EVMXswjOcMlGPSTNzGS1/UgGUC2m0tU8gZRgU1osArau4Amf73n/+Sz31ymR0kn/AgSoiGx+gG9mh755Av/Gq1a9/CfOKv+bHLBZhm33QHClmIL4Bo8seTS0BfvGICgiMDXiwU8xwEsbDCzAUnnmzukdHzMy5DZEn8Oe0uTzAmT21LuMGCRmr3t66irH+fukT6D7LPL2C10mU5JX40Cc8MkTz4eg8Zxvwe94zPs0syCNNufLBgWjM8nh+sDImeD7ITwyBgiX6R9q6Q9q+vbmY4j3GDqLWdaklq5iDwaUAKoxyTJM3akwf+t0ztoMvyxIyGOa6cP+9N/nRfzC+bdWoo58ZMJ/iJYtUeeXqy2RlMndHbrcYT2/ztNI56ANT/B5G6s1o= +sidebar_class_name: "post api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Creates an outgoing webhook associated with the given app version. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-release.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/create-release.ParamsDetails.json new file mode 100644 index 00000000..9154effd --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-release.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-release.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/create-release.RequestSchema.json new file mode 100644 index 00000000..cc23e2d9 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-release.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"artifact_source":{"type":"string","description":"The source of the artifact. Can be 'ci' or 'api'."},"app_id":{"type":"string","description":"The app id for the app version. An UUIDv4 identifier."},"name":{"type":"string","description":"The name of your app version. In case of iOS platform this will be used in the App Store Connect for the app version and only allows X.Y.Z format"},"description":{"type":"string","description":"The description for your app version."},"release_branch":{"type":"string","description":"The release branch part of the build configuration for the Release candidate stage."},"workflow":{"type":"string","description":"The workflow part of the build configuration for the Release candidate stage."},"slack_webhook_url":{"type":"string","deprecated":true,"description":"You can get notifications about release updates on Slack by setting this value. Make sure to send the properly formatted webhook url. Regex for validation: ^https:\\/\\/.*\\.slack\\.com\\/services\\/T[a-zA-Z0-9]*\\/B[a-zA-Z0-9]*\\/[a-zA-Z0-9]*$"},"slack_notification_integration_id":{"type":"string","description":"You can get notifications about release updates on Slack by setting this value. Make sure to send the integration ID found in Workspace Settings."},"teams_webhook_url":{"type":"string","description":"You can get notifications about release updates on Teams by setting this value. Make sure to send the properly formatted webhook url. Regex for validation: ^https:\\/\\/(?:.*\\.webhook|outlook)\\.office(?:365)?\\.com\\/webhookb2\\/.*"},"automatic_store_upload":{"type":"boolean","description":"If set to true, Release Management will upload all successful builds that ran on the given branch with the given workflow to the App Store."},"release_candidate_locked":{"type":"boolean","description":"Set to true to lock the release candidate and prevent automatic selection of the latest artifact. When false or omitted, the latest matching artifact is selected automatically."},"approvals":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"due_date":{"type":"string"},"summary":{"type":"string"}}},"description":"Tasks for the approval stage."},"automation":{"type":"array","items":{"type":"object","properties":{"event_name":{"enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed"],"type":"string"},"workflow_name":{"type":"string"},"pipeline_name":{"type":"string"}}},"description":"Automation events (workflow or pipeline runs) setup for specific event types."},"outgoing_webhooks":{"type":"array","items":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed","app_store_release_cancelled","app_store_release_completed","app_store_release_started","app_store_review_approved","app_store_review_cancelled","app_store_review_rejected","app_store_review_submitted","app_store_version_created","app_store_version_updated","app_version_added","approval_task_added","approval_task_changed","approval_task_completed","approval_task_deleted","approval_task_reopened","approval_tasks_completed","auto-upload_disabled","auto-upload_enabled","automation_added","automation_removed","google_play_automated_rollout_cancelled","google_play_automated_rollout_configured","google_play_automated_rollout_paused","google_play_automated_rollout_resumed","google_play_release_completed","google_play_release_notes_localization_added","google_play_release_notes_localization_changed","google_play_release_notes_localization_removed","google_play_release_started","google_play_rollout_percentage_changed","google_play_testing_track_release_completed","google_play_testing_track_release_failed","google_play_upload_completed","google_play_upload_failed","google_play_upload_started","metadata_localization_added","metadata_localization_changed","metadata_localization_removed","microsoft_teams_connection_changed","outgoing_webhook_added","outgoing_webhook_deleted","outgoing_webhook_updated","phased_release_disabled","phased_release_enabled","phased_release_paused","phased_release_resumed","release_candidate_auto_select_latest_build_disabled","release_candidate_auto_select_latest_build_enabled","release_candidate_build_selected","release_candidate_source_changed","release_description_changed","release_settings_changed","slack_connection_changed","stopped_managing_release","testflight_app_review_approved","testflight_app_review_rejected","testflight_app_review_submitted","testflight_distribution_start_failed","testflight_distribution_started","testflight_distribution_stopped","testflight_processing_completed","testflight_processing_failed","testflight_upload_completed","testflight_upload_failed","testflight_upload_started","testflight_what_to_test_added","testflight_what_to_test_changed","testflight_what_to_test_deleted"]},"description":"A list of event names that will trigger this webhook. These events correspond to specific actions or states in the release process."},"all_events":{"type":"boolean","description":"Indicates whether this webhook should be triggered for all events. Set to true to enable the webhook for every event."},"webhook_configuration_id":{"type":"string","description":"The unique identifier of the webhook configuration, that can be found in the workspace integration settings. This ID links the webhook configuration to the workspace."}}},"description":"COMING SOON. A collection of outgoing webhooks configured to trigger for specific event types. Each webhook can be associated with one or more events or set to trigger for all events."},"timeline":{"type":"array","items":{"type":"object","properties":{"stage":{"enum":["release-candidate","approvals","testflight-upload","google-play-upload","app-store-review","release"],"type":"string"},"target_date":{"type":"string","description":"A valid date."}}},"description":"Timeline settings for the app version. Dates set here will appear in the sidebar. These deadlines serve purely informational purposes, no automatic action will take place at the scheduled times."},"use_presets":{"type":"boolean","deprecated":true,"description":"(DEPRECATED use presets_id instead) If set the release will be filled with data from previously set presets. Presets can contain release branch and workflow, automatic store upload, notification urls, approvals and automation lists. In case any of these values are set both in presets and in the release request the variables set in the request will take precedence."},"presets_id":{"type":"string","description":"The presets id to be used for the release. Presets can contain release branch and workflow, automatic store upload, notification URLs, approvals, and automation lists. In case any of these values are set both in presets and in the release request, the variables set in the request will take precedence. The presets id can be retrieved using the presets listing endpoint."}},"required":["name","app_id"]}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-release.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/create-release.StatusCodes.json new file mode 100644 index 00000000..1273150f --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-release.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"The created app version","content":{"application/json":{"examples":{"201 - Using the deprecated use_presets property":{"value":{"app_store_release_type":"MANUAL","artifact_source":"ci","automatic_store_upload":true,"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","created_at":"2025-02-11T09:26:01.000Z","default_release_method":"phased","demo":false,"description":null,"id":"921db057-73eb-418a-b7ed-04f451e9dd85","name":"Awesome release","release_branch":"main","release_candidate_build_slug":null,"release_candidate_id":null,"release_candidate_locked":false,"released_at":null,"slack_notification_integration_id":"ceec9565-0de0-4603-92b2-255e42c2d203","slack_webhook_url":"https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX","status":"in-progress","teams_webhook_url":"https://outlook.office.com/webhookb2/valid","workflow":"build-new-app-version","stages":[{"id":1,"name":"release-candidate","status":"in-progress","target_date":"2025-02-13T09:26:01.000Z","started_at":"2025-02-11T09:26:01.000Z","completed_at":null,"disabled":false,"view_only":false},{"id":2,"name":"google-play-upload","status":"pending","target_date":"2025-02-16T09:26:01.000Z","started_at":null,"completed_at":null,"disabled":true,"view_only":false},{"id":3,"name":"approvals","status":"pending","target_date":"2025-02-19T09:26:01.000Z","started_at":null,"completed_at":null,"disabled":false,"view_only":false,"tasks":[{"description":"After quality assurance has finished testing, check back here.","due_date":null,"completed":false,"completed_at":null,"created_at":"2025-02-11T09:26:01.000Z","id":1,"summary":"qa-check","assigned_user":null,"creator_user":null},{"description":"Everything is adhering to our security policies.","due_date":null,"completed":false,"completed_at":null,"created_at":"2025-02-11T09:26:01.000Z","id":2,"summary":"security-check","assigned_user":null,"creator_user":null}]},{"id":4,"name":"release","status":"pending","target_date":"2025-02-20T09:26:01.000Z","started_at":null,"completed_at":null,"disabled":true,"view_only":false}],"timeline":[{"stage":"release-candidate","target_date":"2025-02-13T09:26:01.000Z"},{"stage":"google-play-upload","target_date":"2025-02-16T09:26:01.000Z"},{"stage":"approvals","target_date":"2025-02-19T09:26:01.000Z"},{"stage":"release","target_date":"2025-02-20T09:26:01.000Z"}],"platform":"android","store_app_id":"io.bitrise.test","store_app_name":"Test Android App","automations":[{"id":63,"created_at":"2025-02-11T09:26:01.000Z","event_name":"release_candidate_set","workflow_name":"google-ser-cred-test","pipeline_name":null},{"id":64,"created_at":"2025-02-11T09:26:01.000Z","event_name":"approvals_completed","workflow_name":null,"pipeline_name":"notify-stakeholders"}],"outgoing_webhooks":[{"id":"9e1817c7-ccca-4e0d-9155-0071cb07f966","created_at":"2025-02-11T09:26:01.000Z","events":null,"all_events":true,"webhook_configuration_id":"5623239f-28ea-4b8d-856e-8cb50073fade"},{"id":"a4410940-1f5e-45ec-9ce0-b47db15b210e","created_at":"2025-02-11T09:26:01.000Z","events":["release_created","release_candidate_set"],"all_events":false,"webhook_configuration_id":"8352be85-758c-46bb-9890-03b4a8d70950"}]}},"201 - Locking the release candidate":{"value":{"app_store_release_type":"MANUAL","artifact_source":null,"automatic_store_upload":false,"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","created_at":"2025-02-11T09:26:01.000Z","default_release_method":null,"demo":false,"description":null,"id":"921db057-73eb-418a-b7ed-04f451e9dd85","name":"Locked release","release_branch":null,"release_candidate_build_slug":null,"release_candidate_id":null,"release_candidate_locked":true,"released_at":null,"slack_notification_integration_id":null,"slack_webhook_url":null,"status":"scheduled","teams_webhook_url":null,"workflow":null,"stages":[{"id":185,"name":"release-candidate","status":"pending","target_date":null,"started_at":null,"completed_at":null,"disabled":false,"view_only":false},{"id":186,"name":"google-play-upload","status":"pending","target_date":null,"started_at":null,"completed_at":null,"disabled":true,"view_only":false},{"id":187,"name":"approvals","status":"pending","target_date":null,"started_at":null,"completed_at":null,"disabled":false,"view_only":false,"tasks":[]},{"id":188,"name":"release","status":"pending","target_date":null,"started_at":null,"completed_at":null,"disabled":true,"view_only":false}],"timeline":[{"stage":"release-candidate","target_date":null},{"stage":"google-play-upload","target_date":null},{"stage":"approvals","target_date":null},{"stage":"release","target_date":null}],"platform":"android","store_app_id":"io.bitrise.test","store_app_name":"Test Android App","automations":[],"outgoing_webhooks":[]}},"201 - The created app version":{"value":{"app_store_release_type":"MANUAL","artifact_source":"ci","automatic_store_upload":true,"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","created_at":"2025-02-11T09:26:01.000Z","default_release_method":"phased","demo":false,"description":null,"id":"921db057-73eb-418a-b7ed-04f451e9dd85","name":"Awesome release","release_branch":"main","release_candidate_build_slug":null,"release_candidate_id":null,"release_candidate_locked":false,"released_at":null,"slack_notification_integration_id":"ceec9565-0de0-4603-92b2-255e42c2d203","slack_webhook_url":"https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX","status":"in-progress","teams_webhook_url":"https://outlook.office.com/webhookb2/valid","workflow":"build-new-app-version","stages":[{"id":1,"name":"release-candidate","status":"in-progress","target_date":"2025-02-13T09:26:01.000Z","started_at":"2025-02-11T09:26:01.000Z","completed_at":null,"disabled":false,"view_only":false},{"id":2,"name":"google-play-upload","status":"pending","target_date":"2025-02-16T09:26:01.000Z","started_at":null,"completed_at":null,"disabled":true,"view_only":false},{"id":3,"name":"approvals","status":"pending","target_date":"2025-02-19T09:26:01.000Z","started_at":null,"completed_at":null,"disabled":false,"view_only":false,"tasks":[{"description":"After quality assurance has finished testing, check back here.","due_date":null,"completed":false,"completed_at":null,"created_at":"2025-02-11T09:26:01.000Z","id":1,"summary":"qa-check","assigned_user":null,"creator_user":null},{"description":"Everything is adhering to our security policies.","due_date":null,"completed":false,"completed_at":null,"created_at":"2025-02-11T09:26:01.000Z","id":2,"summary":"security-check","assigned_user":null,"creator_user":null}]},{"id":4,"name":"release","status":"pending","target_date":"2025-02-20T09:26:01.000Z","started_at":null,"completed_at":null,"disabled":true,"view_only":false}],"timeline":[{"stage":"release-candidate","target_date":"2025-02-13T09:26:01.000Z"},{"stage":"google-play-upload","target_date":"2025-02-16T09:26:01.000Z"},{"stage":"approvals","target_date":"2025-02-19T09:26:01.000Z"},{"stage":"release","target_date":"2025-02-20T09:26:01.000Z"}],"platform":"android","store_app_id":"io.bitrise.test","store_app_name":"Test Android App","automations":[{"id":65,"created_at":"2025-02-11T09:26:01.000Z","event_name":"release_candidate_set","workflow_name":"google-ser-cred-test","pipeline_name":null},{"id":66,"created_at":"2025-02-11T09:26:01.000Z","event_name":"approvals_completed","workflow_name":null,"pipeline_name":"notify-stakeholders"}],"outgoing_webhooks":[{"id":"9e1817c7-ccca-4e0d-9155-0071cb07f966","created_at":"2025-02-11T09:26:01.000Z","events":null,"all_events":true,"webhook_configuration_id":"5623239f-28ea-4b8d-856e-8cb50073fade"},{"id":"a4410940-1f5e-45ec-9ce0-b47db15b210e","created_at":"2025-02-11T09:26:01.000Z","events":["release_created","release_candidate_set"],"all_events":false,"webhook_configuration_id":"8352be85-758c-46bb-9890-03b4a8d70950"}]}}}}}},"400":{"description":"Validation error","content":{"application/json":{"examples":{"400 - Parameter missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: name"}},"400 - Validation error":{"value":{"code":"ERR_VALIDATION","message":"This slack integration ID is not valid."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"409":{"description":"Conflict","content":{"application/json":{"examples":{"409 - Conflict":{"value":{"code":"ERR_RESOURCE_ALREADY_EXISTS","message":"App Version with name \"Awesome release\" already exists."}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Unprocessable entity error for outgoing webhooks","content":{"application/json":{"examples":{"422 - Unprocessable entity error for outgoing webhooks":{"value":{"code":"ERR_UNPROCESSABLE_ENTITY","message":"The outgoing webhook with webhook_configuration_id '5623239f-28ea-4b8d-856e-8cb50073fade' cannot have all_events set to true while specifying events."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-release.api.mdx b/docs/release-management-api/store-releases/api-reference/create-release.api.mdx new file mode 100644 index 00000000..b8a22cd0 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-release.api.mdx @@ -0,0 +1,69 @@ +--- +id: create-release +title: "Create an app version" +description: "Creates an app version under the given app." +sidebar_label: "Create an app version" +hide_title: true +hide_table_of_contents: true +api: eJztPO1y20aSrzLFui0lLoIiKVISVZtNMRY3xzpZ8omUN4mtQw2AIYkIBBAMIJnR6u89wD3iPcl1zwcwIACJUhzv/ZDLZUszPT3dPf01PU3etzzG3cSPUz8KWyettwmjKeOEhoTGMbllCYcJkoUeS0i6YmTp3zIx12m1W1HMEoorp16+9pIFjHIGs5y5WeKnm9bJx/tWGt0w2ODj9cN1u5XSJYefW2PY4oPcgrdgPKYJXbMURhCy3UoYj2GKwa/3rX63h/+V6Z0DSa7Y1zMJht3dKExZmOISmAh8VxC6/yvHdfct9pmu4yDHTCxyxf1wKXj0WJwwV+DMOLPhF85STuIE+UV+7lu3NMiYwm3zNEqYnUjG7XQTw0zr3fj8anwGhNAk9RfUTW0eZYmLU66Pw1karYEmVy3P4iCiIMY0yZigPmQuUGDjBj6Kd3HguYvuaGANRqxrDRbOyHIOnYHluv3+0WjRdw48lLqShk2BdeCsP7S6favXm3dHJ/3Dk26v0+12fwE4jy1oFqQ52SD3VYT7xCv41RMQ66h1sqABZ+2y2MMsCNotQdWo3/Oc7vDIOjpgjjXoHVPLOWKe1R0sBsMeG3ne8RBwhXCuAD2+YzxaM5LkSqK3dxIauisAWVM/NMZdGnq+BxzZTuYHns2DbKkJqMIgSU1zQeTeAF+aIQUgBSXX8IC6N3YYwXkpdbF9UKJlon5Gfl3G3NHwEKTq4Skcdg+sUd/pW/3hkA36bt/rdw9aGtUdc1ZRdGNnSQBLV2ka85P9fRziHQHRcaP1PmfJre8yvj/vqj/7P+Q//dTwB/dIaZqBArf80ALdXIKachhOGV3zhq2jLA1gtBMtgEMmdleATn8fdNrHc7+LkptFEN3BOiFzK2R3FqihVRgXbL1E2wHDRqn08gNWUrVysT9CJ02WLLUFkKGpBxVNhfXJLhoN3IBFp6Uj9XxOncA49luf3dlRGGzUyENbstDPWVhG0TJgVhzQjaWM0uAhZsBYuGym//BR+iVVj1MqPUAToQc5oXAkSQSHxp9F3+gP09cgSdyR30ilKDvp8QJcOvktA/1KN4RynqGxMwKOhiz80Ocr8LQQdVIgvE3cFXNviAPWQVYsYRhnvIwpPrboy7euo3hXT6g0mGfrNU2Am9Zv1BJEoJfm3F+GgAQCQVJCHCXGGB5OmecJGMsmXWFI8SGcesCKCC8RgShAdGgkcQSRyWf863DZN7nUNDyb12utioNts3+OIva7f5ahYILhr1ngh0woo3BWDb5pRyeEHGs0tf5hR2dg4jHNd0dbNZcXIt9RvigXIDpdRMkatw+9JPKlb8P8I88z/Kjj+Gnic9ZBmywBqOOewzgZSwQEkjgjncFMToeFw4Pd1ZNBWpnaZXUygjckYEZkssuuGlTTgn08S9Eb+7E4fQWmDVSQNHghSflp2YVZVgiSCrq1fUskFBsLDu6GraLAw/QWDwOC8TICE9GxuhBca8R6x70j9wiSO5daA9b1rFFvCIR2j3qu0z1ajA4Pn5HrCU64po8Gga1HpAnpZAGyzoW/zMx8Z3jYP+gfjBZW/5gBJc6xZx0PD5l17DpDoOZgQSHr1NJt0cGgBylq1+othswaDJlrjVzIk5zBkef0hk6/131Ojqqp/FhohFxZmyCijlyX2VN+8xH+jg+GfYcdD62j4bEL+ZzjWKPjUdfqHjgDeuwddUfDLpzWw0NbXRPOII3UFwVFAyk8yh+8GqgDarga5FHgX3U3UA74y98LzkRu/si1oCmp/1KXAmkHL7sTmICltFtN6IjIIdB6WSC0tyZJl9BF8p2vLmXax8Pdcu2G8Jsj/RIZnzb73vHhH8ueX0bV43ly7/joRZnyF5VQkRNfF3QdvyBt+qISenGCpCPp7qnQ9orGpGcbsCG9kQno10tkGsK0EQ+aKlCvRaLXItFrkei1SPRaJHotEr0WiV6LRK9FooYi0fD/X5Ho8LVI9FokekmRCP+0W4Nut/pS/QETJ4GTsCSJkuc9UQNKuGu81+/jZO1zfK4u3TLcyENNmlxe2u/Hl+N3k/nk0n43nc2m5z/CbmvIqKRXEM/sGHEUFhLJt32BCcfZOoawA6N+KPK9EyK0VPEGhFSYaaDjw/hsejqeTy/OSwTMV7CJyG2JkTuT6SluDpZAxK6dViHQmqf/qxDcySpK/N/FUT9LmOK931zfQP/V+fhq/u8Xl9NfJqclDkqLCzIPqmS+Z4kQM/DnsdB/Pq0HePAVJE0HP7kUJ35xbp9OzqdbVFfRFKSPqqS/BUsA4tLnUjwCivO1DYReTmYXV5dvJ/b47HIyPv3Znvw0nc1nJXKN9hBy56croYXk0/YF8VOL0ABM3tsQ9tnnKTcUp9evsjVLwRvQxCNAHws54vkt85Nnn0yvD3w2I2tgfDYfn5+OL0/ts+nbyflsApL4z6vp5dZJCQtxWMgWfqpRQoZY3W6hbDevBcjenFwA/RoBXIUQplzcC1IkAuxikinsWKDTIYfkIed5cun3hXU9c49GC3x/efF2MpuNfzib2JPz+XT+85akWAWb1JYmh072dolXe1jVR1+0oreMFPEC0vIUM3QMiuRu5QN3PGYuBG8kQMIU8h/WhYIpyDIJaUBmcKkHZz55fjwYCjdcj6hBktNziAfnotpUSG8WYUlHii5MyV0SQVB50NSj4kG29EPkbSSyR+nD+vaa4k+quhU5vzLhPVTnlC9pr9S68gU8TeRtoNrkJWFJtBDarlF0yFsagp2QPdffw4C1R2N/D8TfbulUdRfkWLcDvdC2ZJTxOpDBkqur6entACBQjRc+S8QGMnHbBb1wW0D5Bm91JeTTELSMi0n/YkZ05g1UgPnf+UGAvMGtyoM4KUhDlzjDTBsdLBp8HdEEfATByw6qbXTHyU+dnzu/ICQk30h6icRdODBGxIYVTloP1SrdLoj1C5pcQyAzSfUZi7ISKRlvzuzl9sMbETceQUZRmdqFAA39RbauKejV0aC7C3VmXabq5yhD5ASua8QsM4L7d8DR5SLLYk+0agJtM5FKORv0Tal8nAT9EU6gQ97BjYLwDFQGvBaHC7dgQ5okqIjUCgwc2nkC3R1gc8k+C6Zv81zvhPyXrBF++rQPfztvPn2SFUr4Hy48MKSrlPDj/CO1fh9bv3St0TUA7v+w9bv5678Vwnu0sPrUgX4d0W2lrIsoC4V9/gNUiccUvNRM4uJCKWpKrX8CH3Pc5aurwDffnwgtUOv+qUrH38KQrB4DwMHh8Nvvcw3JK8lCgYSjbnjjyIXkRBGwG1akNF2YsbidW+Y7GoJBrkU8QxcqEaIvBBm4mJMsskDaOAdBUJAnyDoKjf5m5Y5EGlGM5r4CtzSdccn9VR8TnuRkZqQU8D+uq+8vEJ4d3AdmGSQXHIghgFCA+qgcWIBqkRph8h8roF9cdDFKRmsfj7ttwgImVyQCehHexSRiTCr1XiDFjY6vqjJV8EeThG6wjJiyNX86EXg0DD2Ytc6aybxGWZl72I5wrTnWnM1IKSg3HHdRmHo5N2YlCH4Ls3WpJrFVpUKZwwVpuUqVwtu6yA2TsmRlY/WwZBQmjMNSaoMmYGFTclQZTtiv4vSMQgjIAKEDWamTuFVR3V4mURYbsOB0q4Ro4DShsh5cW/LimSNVTGwoyRGYBV0uFvaDQBEmhmRF2HZXNFyWCFblXmMERA5XHzy6GvCCCCzwbuvMViWuRqu2ynI76NY4Vx2V/JNvcj8BCqcRkiQL+bfosLJYaKK8NIDxSmPGfWS8qKn4/SGV3GV9Hode1fZfrLbtmmYBc+Oa2UfXFoSYc9vir8w1bbl9QJW5XISlSXVNMCqz1TmZzOg5PUo9T4+JA7Px/bBhtJDr1nhZQsaMx+rHEwZmFFYnyuqCUUO97tj5g1N5mIXmqPQTBfXFUMLW6ihM3VUAoI9JBDe5LC2dyxOQ6vayA2hMM74DWMIg5lbg6tSwbh7yWMYxJYJc8veyHHYEL453xwX1Qq1aRmlWy6TOXE3Akkd5Ugr10AvqV49SaU4TJu1SH1lacLYGtwpWRevlXj9bsFs/X0h17btJxKNFass7jqpBlpFsh7N898pEYYyVqcI3yMajXIKG2W3NFJa3NZFr+9Z4od7V4IfGYMtk2Jb5suo0MvZ/xqqCtsYOJpV4179hiVpYTRgxMpO6mKRupcaUvHPXnhs45zgG8azxNoVnYbwlF0kAuupqOKkHMMJGPYAZOwwIkDGkJ04mCBS6XWj/o2BPQAj+yhCqZo3smvZXD1FHRI3x1qRMzQtr6b6DO6oNqiQ0SJtP03xxgk0Q2s6uq7ksCUBEeImUSSkmweqKLG7SIL3lUnwQGMuT0jY72AEJ10qV/LpRIj+164lag05yqSvrF5j4pqJmoQqa+oqr5CpvY8bj7NNVALAKV2C8WzHAWKaO8FWUBR6WURXxTNZ5sRqgivVk6/otrVNQp7HgCobNOnKNrDM2vhfvUnfMQv83fGzNa8r66q63LKFty0NwZbE7rzilqoApq05mXUrbOp4OSGN6Cicb3vDmHXRNI0fXqbvsvL14Nz3/kcwuLs47ZAwYAqPwUHnTIUUOIuUrtafx9kMm1F0V5ElmKeeR64v2WlGOiUJRwlhjDVzpHOLTR1hsYZywKMPl3T4vvU2ppprK3b7UK1Rq2MkNsOgBqm0Mwr5JkQxbxp1Detu6a2ypl+cpZRvL6h1B6NoznSvB5DpT/w5yKmwM5YwNd9IfAACjidZEDsrs0EQ7BI9RD/HiouQWLBz0INgAsCw3AlIa4GAcccbbJIyMgpZ0F8rpYPES5AUaDiYgNtIfpCB4qPJ4jQ/qNziNx6vu35xO3l9O3o7nk1N8cCEKFz4X+iGH/Mb7luiCo+G29BvNwsekXGoopkxkkURrUanzo4wHoiyrcXbIe/WNAqji+KhGQYJbLyFY6NN1hLZZ6hOPP1Jz2qXiMBZtQY65AgoUxRVDuHZePDnRcKNcDledH7AiEVpAnAjYAJr0Nx/Qwt1oMtXToOobSXx0mVI9ckAJYJwhHAADf+fKmlsh4d08pibGF85Ev4tpXVV0/Vmyvbo8M2Xb/irCbb9QumRLXMqTJgyECx4Rv9VCf4JNQyH94v069GLw4Rjh1Puv7GX4KJ8782fVa/lAXHweIJJNdTTF9vx9oxFcNB6L52nZuiZ7ze8d4BOE+rCvneg6r9rv3/b3tTcUc3z/tgdYckGgvqj1sowsPqRgdLDT2M/bE/2oVpskSQTR4OEWpX7xii095XXxHSYzMSpdi/wmkyKKxP5/MBFGEPcKPAVLKlu+H88J5Nj47g5JBOgv+pjx+ynBgjqKSHcQqq4iWYtGEePr+mXxDj+RTQC17+iF9eR9mvmIwt9gX/lw5ZMW+YzR8J+P7fJZiBy47iMHBcGPftDlqc/tGW8Rlb7yguP8NcFgoGh0VtH1uvwY8PH+ZU2n+Q7bfZ7GPvWtnTXtjI81Lz7Zm2ls+MKGZwOD6bONhARjurAIP0XVbNW8xKGuW6T0hT9g0fqzUq3bfqdX0co3b86AKXRL2stHkMoDpu/fvCH6jXTho/+UWckJ+Sslq4Qtvtur8ytgqZYXuXwflrDPnVW6Dr7HoNmJEx/V4ByO6DtF+1/63YJ6+AV2hX8/9OCfU0CxR6SMvtuznYCGN3t/+9ATPGJi+9d9+rdP4adwXlCcJwrGdwtB2Pg7c5IMPUIPfHm/2z8qvdViyr8BNkUH0tpHs1KZNDaVsDuB2GGLSACzsIObPioBiQSkay0zyNaECGpYgRRU7AE8/e9//w/50Cfv9ELyIy5EDkUMB7cP6PHslX7Xf4HU9tEavUTP/Mop5XRT9jndh6QQfC4mf/JRXUafj61S9AGtXWFwgvF7GXWS4OEBh8GnounjZ/x0aJEf1NROHM3khm1kJyRSa81x97Zur6p2QWGPs1wxdl0Wp4/CXhvx8/3FbI7PIKrTai3bthIqrgIUnS6WxWLVOn8vx+5bcF7LTNqxxPkgHzNX5fh0I+KT+kF8G5eaCjcmhaXY01aM4L/IVu2S+3sZ/UCgGl5ONa7I46OExvPDXOL/APZFrUc= +sidebar_class_name: "post api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Creates an app version under the given app. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-staged-rollout-schedule-android.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/create-staged-rollout-schedule-android.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-staged-rollout-schedule-android.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-staged-rollout-schedule-android.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/create-staged-rollout-schedule-android.RequestSchema.json new file mode 100644 index 00000000..2c4f3a90 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-staged-rollout-schedule-android.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"location":{"type":"string","description":"The time zone in which the schedule dates are provided. It can be any TZ database time zone or UTC if the dates are given in Coordinated Universal Time."},"schedule":{"type":"array","items":{"type":"object","properties":{"percentage":{"type":"number","description":"A number greater than 0 and less than or equal to 100 representing the release percentage, where 100 indicates a full release."},"when":{"type":"string","description":"A date in ISO 8601 string format specifying when to run the schedule."}},"required":["percentage","when"]}}},"required":["location","schedule"]}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-staged-rollout-schedule-android.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/create-staged-rollout-schedule-android.StatusCodes.json new file mode 100644 index 00000000..5c5fc982 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-staged-rollout-schedule-android.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Create staged rollout schedule","content":{"application/json":{"examples":{"204 - Create staged rollout schedule":{"value":{}}}}}},"400":{"description":"Percentage out of range","content":{"application/json":{"examples":{"400 - Invalid time format":{"value":{"code":"ERR_INVALID_TIME_FORMAT","message":"when must be a valid datetime string; given value: 'gibberish'"}},"400 - Percentage out of range":{"value":{"code":"ERR_VALIDATION","message":"Validation failed: Percentage must be within the valid range of 0.01-100","details":{"percentage":["must be within the valid range of 0.01-100"]}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for Android releases."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-staged-rollout-schedule-android.api.mdx b/docs/release-management-api/store-releases/api-reference/create-staged-rollout-schedule-android.api.mdx new file mode 100644 index 00000000..65dfe1ea --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-staged-rollout-schedule-android.api.mdx @@ -0,0 +1,69 @@ +--- +id: create-staged-rollout-schedule-android +title: "Create staged rollout schedule - Android only" +description: "Create a staged rollout schedule for the given app version." +sidebar_label: "Create staged rollout schedule - Android only" +hide_title: true +hide_table_of_contents: true +api: eJylWGtvGkcU/SujlSq3Ee8kbUXzELVJimpjl4elxkHWwA4w8TKznZ3FIYiv/QH9if0lPXdml4cBW1bzgSzs3jPnvs6962UQimRkZGylVkE9ODWCW8E4SyyfiJAZHUU6tSwZTUWYRoKNtWF2KthEzoViPI7ZXJgExqWgECRilBppF0H9ZhlYfScAeTNYDQoB0BJcBw0YXHuDhBXZR60nAL2K+IJ1rTaCdUQkeCIC2OhYGE68WuGaWdfR6nhW3YxUQ4VGyxAEYm74TFgc4CgofIGpuyXJvZjbKa6N+CuVRgDWmlSAN4BmPKiD9CImi8QaqSbBiqgbkcRgKxK6X6u8ov8OBu1IyHDeSCsrlCVLRCySI+dW+UtC5stAfOWzOFofgLg8gYjn5jxK6WLl/hWCV5XKPrErYUY4FyCM7PWYGa4mz2QEZDBqKZwoQ2blzBXBjNttGgAMKXDNTue21b5unLfObnuti+bth8vORaOHE2ciSUAEz9xPUTmzNLFsSJXmcUP467B96H/JCszh19nJRA6HwshkehJk3oLTMfeO8HKsGr3WZXuHzjWd79xnYy4jEda3gXOe99JOpXKl7wm7o+jMSqlSLVYR/gKib4HgohavIajsn4EyWG1SWt1PaV/x1E61kd9E+Nw8VhGzHfsjgeq3G/3eb5ed1qfm2U6odow3NF8erLyZTKjNWSiUfD7Xlz6/D0COEL5qdi5a3S4ye3vWbLcesN6H2VA/0M2ZAjGlLQo9Vc+mTg28D3KEevuyhx7pt3cp91Ag0B2doojYiCuCGYoMac2+WttnD4FUITchA0kB1WJrrXueF9UavDgOdsSbbq/RPmt0zm7PW6fNdrd522n+0W91mg+9kwncUWIsbQ6ZQAn2jsuHDYgrMbKQQvAubQJQOxCAXKjiiFvSqWf6Xattid0a4wmluzpv9Ejo9r0UKoy1VJbhWqtowdKED7Mxmo0tRMDVSrJx7PUhMW/BCaN4xLrCYOaypjHaPM+715mUHwI66mKv2Wk3zndc62oMWQjZhN3jZHZvtBuWGXvKqEjsrzpceLBH+e3NXj38glzTMDe0AVjpuUfaG+5P6cKDQFHzuFHyTSvBILf3UzmaukJarzE0blByWDhwylyGIiyxlqVWc0NJLVjvEz3Eh9TFGzSkrd87ZXLs4DYoflrhrFOtTSgVp2LtK0nLESLdAwDS6zeNfIRnXnBj+IIWFCtmydNx2B4s62dVOsN43ItEg/kbbOL2CWomOFiBf+gxZNN/h0/IGFhazTCBUI8x+hFnUIKtUyIvZpujC4ipgNv0uFQh5dR18DiNovxx5y/N+qcz1nCRpPC1upfs5x8xqfyT2abBkliM5HjhKo62BzA1qdpJaSnIa88L1M12pDIig9XDZ9ZVtZWagS9jKnFNm2esE5cG2h3rQRlFXMx23qS8lOGqPHFbbBFqsSgmtMWW/eJWzBa34tYqmLie8+tpaiIALqnE+p3zVTkLXHHGFcxn4F6e18oOsZiLRHleBcqcG0k64iois/eKMeZphF4LptbGSb0MtrI0lAgmEiL1wV7xlJirdOC4JWUdWle3bg/Ol/uu+9VXql/xN6Ucy9/FIl+2p4KHB4ryqtFjUHMSE7OgTKY4t3HVQvNF2J0K+daerxo+P5QRkozORlyaXtl2xWFTYptWu9ntmkpelus1f7AiymPtXJGWbNZrwMU6GY5kkW2/wlAq/CUs5rVSdc/bFy/Otb7LStlFVUchIb1/8YL9qVMnOWP0EMMspJ6qszecTY0Yvz05VBAIcTHUo6QME/G1NLWz6D3qKCnFRs4Q0DaC9zbj/l2tsmGPLzgVn9dVfJwB4oRZbibCvj25HUZc3Z28u646H6nb3pT5u8/qs+ptGKMw0N2Qx5AEYuQkDjvVBzE0KaWyih23Vqn9VELM7lA9KQQCAmPZAm5O+RzLtJwYZ4asUyiUuHfAQzHW7mGhSnTooxHwIIhucZJCuF0IDrgigU1nwKd///6HXdfYRW7IPpIheUgSRe0NeMp9VnmPv31RCWSTmyb6w4xvDbz/+TadNZUVX20Z2oKeAlunGctMjG6CbTGCSd296u7pEXXDEUVCY09J34C19EpkotWKfkafGXqTH2zkxrVSKN0KA2Uc8ygRj7j/fSdT2h/YMXdy4VALp2pu/whweQcZcS/urjczJaHT/Y1Tf0axR+Ybw739YlXILRqjkYjto88OtjT/6rJLL63DbIeZ+YXI8Hv66wE+HUntfHZK6H6DDuF1LvU7ksck2SIh2xXJOyeS2YX7W8mhMOwKYB4T+iS3Dposl16CkcH8eX/rqMVapLOIUxzA+j9Dijib +sidebar_class_name: "post api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Create a staged rollout schedule for the given app version. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-store-release-android.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/create-store-release-android.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-store-release-android.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-store-release-android.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/create-store-release-android.RequestSchema.json new file mode 100644 index 00000000..4f7627ef --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-store-release-android.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_fraction":{"type":"number","default":1,"description":"A number that is bigger than 0 and smaller or equal to 1. 1 means a full release."}},"required":["user_fraction"]}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-store-release-android.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/create-store-release-android.StatusCodes.json new file mode 100644 index 00000000..8e100ab9 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-store-release-android.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Full release","content":{"application/json":{"examples":{"204 - Fractional release":{"value":{}},"204 - Full release":{"value":{}}}}}},"400":{"description":"User fraction out of range","content":{"application/json":{"examples":{"400 - User fraction out of range":{"value":{"code":"ERR_INVALID_PARAMETER","message":"User fraction has to be bigger than 0 and smaller or equal to 1."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for Android releases."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-store-release-android.api.mdx b/docs/release-management-api/store-releases/api-reference/create-store-release-android.api.mdx new file mode 100644 index 00000000..5bf54d23 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-store-release-android.api.mdx @@ -0,0 +1,69 @@ +--- +id: create-store-release-android +title: "Release app for all users or for a fraction of users. - Android only" +description: "Release app for a user fraction" +sidebar_label: "Release app for all users or for a fraction of users. - Android only" +hide_title: true +hide_table_of_contents: true +api: eJyVV+tu4kYUfpWRpSptxCWwu6qE9iJ3Q7aoCUkNidRmIzTgA56NPeOdGZOliL99gD5in6TnjG1uhnSTH8Tgc/nO7TszSy8EM9EitUJJr+MFEAM3wHiasqnSjLPMgGZTzSdOouYZmGRa2IXXuV96Vj0Cqt0/rB5qnuUzg8+ej7p3oA3KG1Znn5SaxcBuYr5gA6s0sMKJhzoqBc3Jci9E7x81cAtOqJDxZaiVCNFvyjVPwKJd51niF9RwrwQhT7mN8FnD10xoQGtWZ4BwJxEk3Osg1kVKGsZqIWfeihBrMCmCBEPv22ev6d9uPi6yOGa6wFvzJkpakJbkMEOxmDjszS+GhJcefONJGq/NYfAXReL4xgq+m/M4o4fVqlbKbfvZkaC/mvf67KwK7na7NExllqkp01zOXggVjSOEZ6xtAUK7IaWxGwSjXv/Ov+ydj278wL/qDrsBuk3AGE4qe+gibphVbAxsLGYzfGMjLtkZ4zJkJuFxjD9hv2H1MFUo2Gp4m9hbB2KXPLOR0uIvCF8abYui3dY/Et9t378d/nod9P7snu+Gtq28gfmqCvMGdCIMjQILQYqXY32FWKtGjgC+6QZXvcGgd90fnXf7vT3UVTMb6Adav6QCqSxSQSZfDJ36umrkCPT+9XB0cX3b34U8jACnwqhMT4BNuCQz2EK5pTX6VruKfmCxs7gOGYIEHHG2JoaXRdFqYxTHjR2JZjD0++d+cD667H3s9gfdUdD9/bYXdPejEwbDkTAVtjRpkHIr7oiJLaYCgUuYWAiJn7cGpH0gAT2JwETI0phb1E9eGHeb4q7Y+D8iuPSHF9fBVTVKkGGqhLQMn5WMF7hW+DjOIys4vqQ/swnszSHW62EQmgh1AHqOrNHVWumXRffGEd5hQ0dDRH7r+5c7oQ0UbqQI1wl7Qs/sSSu3WQr0VFEw9hcVLnJjz+KrLCo1/oK1ps2naUtakWOnfTxa7+ONuMySMVAeQpjyLEY/rdpe5nyWCxH3ukp8LxWzFkuAS+rN6daiokJtb9z7PXAPeR4oR4rWe6qMi4c2dcdrYhbq8+Kc0FyKcNWcuaNCHdttUTd0CmhuVq9xRcqXf6ZjNLAc45vb4HJVStUTLrEwCWa5OW83nYV62VXNeQutzLkW1HgulYV+3mJF0rzI2tR0mohONMYCDwsYp1Defi6JmXJIjMwwtMOehI3cnLpauvTQKaM8MQ3cr85zcW5aFw+d/QaL8igTAQ+LUu7sEn/IcPyp+/SCCoPZZv5ND4kxjg2KF2eicje5/nIloh4LNt3YzUfhQDe1VgRhqhw0YUlmvQeu1sl1Tuts+5xHqc0fUWPebrQq6E9PL5V6pFkp2UzFIVn6cHrK/lAZ0TubCuxBJMMINHTYW84iDdN3J4cKjCmrh2pimqgC3xqRTeIP2BemkWqRYIL6mIx3BfYf2mcb9PgFveLnXQs/ztHECbNcz8C+OxmNYy4fT97ftVyMJoXJ2yZ//1l+lsMNYiw0DgHuoRBSDTjHSMi4VC9grDMqTctY1j5r/9zAnD1iN2R45nUjt8AwIz4HloiZdmpYRUqFhCdneAxT5YRBNsjpsxnIjWB267NMhOBScCAUgbbJB8b079//sLs2uyoV2SdSpAg9LDyNJ5qn2hedVLkNYNjUMYb4Ib8ebA6M0/xVgzqjYHRi+v1G2CLC77htFPNh4ZttIi3geCBQN/7LgkfuvW0eQZWOuxNUqMTdDdb3joioCHWXOYnoeLWin3FENN1sHjZM4QgnFG5dIYlNeWzgmZB+DAo6/Ikdg1/OvFw4QnK7xsPHR2QAd6NZPaBUQQLkPX/xMfdRH5L6RrGyS1a1UsOfTCC1z8o+bNHzzfVgiMLjYl8l+fLT/IlSh58OpHIxOxJzvy09bLNZlu/D3CYxDnHQLr89On4rHtzd8VAadrmrzAl9UlgHVZbLnD2xgqV8/uqoxppfi4xTHhD1f9elJy0= +sidebar_class_name: "post api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Release app for a user fraction + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-store-release-ios.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/create-store-release-ios.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-store-release-ios.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-store-release-ios.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/create-store-release-ios.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-store-release-ios.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-store-release-ios.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/create-store-release-ios.StatusCodes.json new file mode 100644 index 00000000..4341185b --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-store-release-ios.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Release","content":{"application/json":{"examples":{"204 - Release":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - when the release version cannot be found on Apple App Store":{"value":{"code":"ERR_APP_STORE_VERSION_NOT_FOUND","message":"The app version is missing from App Store."}},"422 - when the release version is set for automated release":{"value":{"code":"ERR_CANNOT_BE_RELEASED_MANUALLY","message":"The app version is set for automated release.","details":{"app_store_version":{"app_store_state":"PENDING_DEVELOPER_RELEASE","release_type":"SCHEDULED"}}}},"422 - when the release version is in an incompatible state":{"value":{"code":"ERR_CANNOT_BE_RELEASED_MANUALLY","message":"The app version is set for automated release.","details":{"app_store_version":{"app_store_state":"READY_FOR_SALE","release_type":"MANUAL"}}}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-store-release-ios.api.mdx b/docs/release-management-api/store-releases/api-reference/create-store-release-ios.api.mdx new file mode 100644 index 00000000..ef515242 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-store-release-ios.api.mdx @@ -0,0 +1,69 @@ +--- +id: create-store-release-ios +title: "Release App Store app. - iOS only" +description: "Release app" +sidebar_label: "Release App Store app. - iOS only" +hide_title: true +hide_table_of_contents: true +api: eJzNV9tu20YQ/ZUFgcKtYUmWkqKAkAtYi0mEypSqG5AmhrAiR+bW1C6zu5SjCnrtB/QT+yWdWZGSrEsCv9UPNEXuzJw5s3N2uPJiMJEWmRVKek2vDylwA4xnmXflGYhyLezSa35aeVY9AC75dLe+u/Isvzd47/lZxsagDVobVmH4MwW6soFVGljhzkMLlYHmFKUdY5wbDdyCW1SsaXcHGDHjms/BokcXU+IPXC1ifCUIX8ZtgvcavuRCA3qyOgcEGiUw514TUS4zsjBWC3nvrQmrBpMhPDD0vnH9kv6dzBodR0pakJaWIAWpiBzk2p+G1q08+MrnmGHpCTMuTfHBgqc53azd35X38rp+HGokeW4TpcVfED8vHrrDeE/s94Kip5gSD/r9ySj0R8MP3X77j6CFMeZgDL+Hw+A7mC+OYfZAz4WhsrIYpHg+1heI9djJGcC9oH/bHgza3XDSCsL2AepjNzvo54vJpLJspnL5bOh7Zd1zcgZ62B1O3nVH4VPIwwQYbjuV6whYxCW5mULhaYu+3jhGP7BcxlzHDEECblq23erPy6LewCzOOzuTzWDohy2/35p02jdBOAgm/eD3UbsfHGYnDKYjYSZs6dIwfhxupjSzSAUClxBZiElXqjsCGicIaEsEJmKWpdyi/fyZeTco78cEpAusizIuNhJ1WAqGjw4k6xwzfq+H7HT7wWQc9N1OPV95BLmNiEy5zSvv2Uyr+S4Q0XD1PbxobcA6HrFz1ZwTh/pYcvaR3vghQfuVitcJ/EHQmtz64cjvdD5+D+nZWFW0jMFykZqiChNDSUwK46cPjUVbatwgbLXD99jT46DTxSYvETkFd44nhV4Pbj4ErVEHN9p2a3yHFyEZxxsZqTkeCmKKRSzi/t9p6Qd+6yNuHWw3v3OCiw2sJ0QcNcWZJNvh2O+0W5Nexx9igNvjtgUZZ0pIS3kpmS5ZbjhxR/mJ7qDMzOy69Ofr61Ndime05CkbgMZkWaC10s9rVfTrMjvl6Gx6w6AfIjf7aQ0UDgwJNdgjRmaPWrmDv0BP7xRNHJky1g0YOEA0vRqiqxRVMrWViNf0JIUKPXflquntUGActM1EkusUzVdTfDPqd9blqsqcS4QzRwS1RaPmPFRKLmuLOnpZcC2Iapd8Yb8hdsbzFCnzEmsz06whElGdCpxgcIcJ5fbYPve0QzeQGLlh6Ic9Cpu4TnGTkBMXGn3KAW7gnrrIxRi3nZQw2G+wLOerBHgM+ihkzx8yVHDiXC+ZVbhrUDN7bRTUFPf+VTmoleOFq7oTOCFnykUTNoW90/l2y5fz40bH7SRJbJUd5C0a1foRoMvLjlIPTlWLM0alMXl6e3nJPqqclJ7NBEo8HlEJaGiyV5wlGmavL07VDFmoxCoyNTSBr9XEztO3WGpTzbSYY84h5ve6wP5D43qHHn9gVLyO63hpoYsLZrm+B/v6YjJNuXy4eDOuuxxNBtGrGn/zWX6Wwx1irF2a0pEUQ6YhcvqCuvMOpjontuvGssZ145cqcvaABc5xrrYJt2yJaSZ8AXjA3GtnhoUhKiQ8OsdTmCm3GGSVgn6TgY0TZLdyn4sYHAUnUhHom2JgTv/+/Q8bN9htacjekyFl6GHhqd/QPdW+2Bxl6XefBzQNYOlJd0iLDqu82snJwYdJsXctfLU11ETcuhjRteaq6PBP3n6Ho0nTfUQcNPlOfOkTJSGJQMvVpr11ul7T4y85aPoEutv1sJOCWDjpRHGZ8dTAN8D/2C/mrp/YOfBlN8qlkwqnfR7ePmBvug+g9R2uKtqTom9e+FEEmd0zOVJdkoGtCPa6gyGxkBNF+xLw4CSguHFfe6fwPG3vEhxd11dnTFarjcAgleX6zauzFlsJKlKnFFDN/gMgE/1u +sidebar_class_name: "post api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Release app + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-what-to-test-description.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/create-what-to-test-description.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-what-to-test-description.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-what-to-test-description.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/create-what-to-test-description.RequestSchema.json new file mode 100644 index 00000000..c8184898 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-what-to-test-description.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"locale":{"type":"string","description":"In case of iOS platform here is the list of [supported locales](https://developer.apple.com/documentation/appstoreconnectapi/app_store/app_metadata/app_info_localizations/managing_metadata_in_your_app_by_using_locale_shortcodes)."},"whats_new":{"type":"string","description":"The description."}},"required":["locale","what_to_test"]}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-what-to-test-description.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/create-what-to-test-description.StatusCodes.json new file mode 100644 index 00000000..c62069b9 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-what-to-test-description.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"The created \"What to test\" description","content":{"application/json":{"examples":{"200 - The created \"What to test\" description":{"value":{"id":"921db057-73eb-418a-b7ed-04f451e9dd85","locale":"en-GB","whats_new":"Awesome test description"}}}}}},"400":{"description":"No release candidate","content":{"application/json":{"examples":{"400 - Bad request - locale":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: locale"}},"400 - Bad request - whats_new":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: whats_new"}},"400 - No release candidate":{"value":{"code":"ERR_BAD_REQUEST","message":"There is no release candidate chosen"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Invalid App Store Connect API credentials":{"value":{"code":"ERR_UNAUTHORIZED","message":"The specified connected app does not have a valid App Store Connect API credential"}},"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/create-what-to-test-description.api.mdx b/docs/release-management-api/store-releases/api-reference/create-what-to-test-description.api.mdx new file mode 100644 index 00000000..cd6f9ae8 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/create-what-to-test-description.api.mdx @@ -0,0 +1,69 @@ +--- +id: create-what-to-test-description +title: "Create the 'What to test' description - IOS only" +description: "Create the 'What to test' description for the given app version." +sidebar_label: "Create the 'What to test' description - IOS only" +hide_title: true +hide_table_of_contents: true +api: eJy9WG1vGkcQ/iurkyonEQeG2HKC8iJsSIpqYxewq9ZGp+VugK2P2+vuHoQgvvYH9Cf2l3Rm746XHLixVDUfyLHczDzz9sysl04A2lciNkJGTt25UMANMDMB9uD8MuGGGckMaPPgsK032Ugq+9JYzCBiPI7ZDJTGX8pOydHgJ0qYhVO/XzpGPgJqvh+sBiXH8LHGZ6eBAnepgGYu6xmpgJ2D4awptFFimFg8KCFjUJy+tIM1PMLVl31E1dwCX3JirvgUDOq1liP8gjIiwJ8EORdzM8FnBX8kQgHqMyoBhOtPYMqdOmJdxCRBCKKxsyLECnSMIEHT77XjY/pvN2R9DINvcQVPxgwt+zIyEBnSgSELhW89q/yuSdHSgS98GodrUxiY79aNEjMeJkAPgiL1tlYNhsenZ+7Zaxi6J9U33B2eQeAen4xOTqvwNgjenCKiUPo8JJ8hcj+f48EcbWgvgjmeNeag5RSsvR1rK/uv5Jzsi0dHMgUhcI3QeRSIANE/z/cT6/s5Dxilioy7LAe65acvA0Le6na9m0a3cdXqt7reVbvXa3c+o8EpaM3HYPOOdcGEZlOhNWaWZcVrNdE5TGOzoFMR4ZkI6rm5zMkCmq0o/U+ANhY3mPZG+gCg80bT67Z+vm31+jtQsMKUNRntUcb8idSwne9qMd+3EU/MRCrxFYLn5rmKXrRTFxlxQkoEFzKKwDescdOm6g9QneChPuTabadx2//xutv+rdX81jemY/DFSGD/+KlWfCK6CiSQz4ZN+AwYZ9+HIQs+wd5x+7nIdoQ30X1djO4NKFskyLmIQTw/xK8Ra1HJobJtdW29Xne8ZqvT/gZ1Uc0G+kkRejcrJ4rySCbRs6GfIPSikgPQO9d979P1badYAkjhMlG+rWtSM4RM0xp9tVZE3zPYBVwFDEECDgC2HhvP86JaswPukLID3vT6jU6z0W16l+2LVqfXsr3b7hYKHBt3CBGMhMlVaizmgrl8XO/0QHkTgNqeAOR9GYfcoPz0mX7Xalu9vdZxwN12565x2W56N5eN/qfr7lXRS4iCWIrIEFXJKFywRPNhmHomrns5d+mNU6f7hlMbHVARD1kPFG4srKWUVM/z7NRy735FB93DSdBpXO641cPRaibE/nO0zOZK2p0jQ5/NmnMZLFJlT+IrrDBy+DvmmXYiRRuUESn2zRTdXXVKhTBhs2DdyJENbp4+lg8LqqUQNzV64V4ncSwVFVWqXg9eTIyJdb1SCWAGIQEoE2oo+3JaCaSfTNGX1AM810S4WWXyWNCRZ8/sEwaJ4yzi9ouIRtKzVsRXK68rUx7xMfqwfhFf8hbY8B4JDBdeQhM2FQJPI+kayox+iZWys+78W0yISrZOyk6eprSP7/Pgpko9Iz3am5xBmk/KtaTFLJba5oV20bpDXrnZ6qwrSxGsKkP0ww221uAK6XONdK0+Wq+p4tIdN1EhalkOMVm33ctVJWsD10YFKMyVWa1io+nmLVKZVVHLjCtBHWTrIpNP+2XEkxArzcmTiDkpDwXC0VAWcm9cUkiM1DDUw+bCTGyR2MIE25SDzcWgZ0+t5ex6sA4+GvsJFvnGPgEegCqYvGn0GVYLtZJa0EacoF07qXmIe0IpX/3zIcuzrbXkUMN0N63VSvt6uzU26d9ehfMrAeEaSYtXGPt6PqCu1hG3SFy2fceheKePKDGrlasFl169upTykdgg52oZBqTp46tX7FeZ0PBiIxEFDKme2rDO3nE2UTB6f7Qv6xhHFztNV1AEvpQnZhp+xGLR5ViJKUatgxF6n2H/oXa8QY9f0Cp+3lXxo4kqjpjhagzm/ZE3DHn0ePThrmp9pN3qXYV/eIgeov4GMWY/DGnKBhBjY9vLC64Mn2CoEspXFXmjdlw7K2PMHrFEEkUXTrzaYNem69hUjJUVo8sOKsYcWMVDGEn7MkRlMvpkBFIlGF13nIgAbAj2uCJQN9lAn/7+8y92V2NXuSD7TILkISWeGhfVU+6z8vreyzJOCyRRmlrfpn2L2P+bq3fWRQa+mAqyNjYRIrckscwo597ZphwUqdsLcoF1sgZY8w6274SoCxUsU75R4WpFx9hNiu76gw2pWG5CbfSMpDfC7R2ecP1FN6PRl+yQDzk9RAvLXXbGOvj4iGRh7/irAb6V8QVZT3+4SG24fRLfCBZm6KqUSzR8H2Lz5LuDLTq/ubYXqmE2p6fp0Fd8Tn9o4PMUpLQ+W76zZ8g2PBon6R6Q6iRyIrrapcJHS4XZg/1ryr4w7NJcHhP6JLf2iiyXKdFiBvP3058OSqypOIs4xQFR/wPR7EVZ +sidebar_class_name: "post api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Create the "What to test" description for the given app version. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/delete-approval-task.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/delete-approval-task.ParamsDetails.json new file mode 100644 index 00000000..560fc774 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/delete-approval-task.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"task_id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/delete-approval-task.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/delete-approval-task.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/delete-approval-task.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/delete-approval-task.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/delete-approval-task.StatusCodes.json new file mode 100644 index 00000000..00e74745 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/delete-approval-task.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"The deleted approval task","content":{"application/json":{"examples":{"200 - The deleted approval task":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/delete-approval-task.api.mdx b/docs/release-management-api/store-releases/api-reference/delete-approval-task.api.mdx new file mode 100644 index 00000000..5a3848a8 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/delete-approval-task.api.mdx @@ -0,0 +1,69 @@ +--- +id: delete-approval-task +title: "Delete an approval task" +description: "Deletes an approval task." +sidebar_label: "Delete an approval task" +hide_title: true +hide_table_of_contents: true +api: eJy9Vu1u4kYUfZWRpSptFHBgs6qENrtCxduiTUjKR6Q2G6EBX/AUY3tnxiQU+W8foI/YJ+mZwTYhhkhRpfLDjD1zzz333rlnZuP4pKZSJFrEkdNyOhSSJsV4xHiSyHjFQ6a5WtSdM0fRNJVCr53W/cbR8YJgcP+QPZw5ms8Vxk47SdgdSQUsxWqsnSMoB2vihCQ3Xrp+6adYMIQHOEi45Et8lsq6iPCCpcLHlDDkEq4DjCV9S4UkwGiZEnhNA1pypwVS68RYKC1FNHey7KwEMTGM/wPSg1msEsRFysw3z8/N337yhgEx3wbm72cPrqZxpCnSxghToZjaXLh/KGO5ceiJL5OwxEbyjoNhCcYp+G0y+ztzLs4bVTqjiKc6iKX4k/y3MQAcGOzZP3MKJN8kx+v3x6NeezT85abf/d3rwMeSlOJzeul8R/NdleYtyaVQZs8g3ki8nes7cK2CHCF86/Wvu4NB96Y37ni97gvWVZgd9Ysq9T7qwxWxKNZsFqfRm6lfgHoV5Aj13s1w/Plm1NunbPYJtmacyimxKY8MzIRypJJ9o1llP9A88rn0GUgSNjYr2+FtUTSaiOI42JFoBsN2r9Pud8ZX3Z+83sAb971fR92+9zI6oRBORDOhC0ioU9XdLJZMIxUgHtE0b5p6mYD3h/q1ixhlhLYakFyRZJ6UsXxb8O9trx4GOhJ4tzf0+r321V6cgxjCF0Br2CM8s0cZW9nJ2Zu52MjmVhCsVELAWo4LfrVVrrjuRviZW2gFXnPRy6x2G2JbXU1lCNPNBJtu1L/KXLndgLUlj0BmCf/uqukqHUuq5XPKXTWAsuJS8Ekeem6/TeuMpyES5gRaJ6rlgoWoTwTUU1FdxDCtKuWWEjMwDDjsUejAltCqMNnaPexOnYH9aj3nZ0+p0nD2hdaFtgfEfZIVl7ftIcPOMBmXa6ZjlsJv+7aLnglxQp0VJ0UhW7bm5gwB6iy23oQO6VnXX5f5sjj2vCuPP5Ot7RAWq2a9USF0enoVxwtT8mLvxqFvkD6dnrLf4tQ0M5uJyGfY+gFJarEPnAWSZpcnh2qGLNT8eKpcmNBTPdDL8BNKreqJFEvE3EN8lzn375rnO/Z4gVc87xp4dABxgoNGzklfnownIY8WJx/vGjZGldD0g8s/fo2+RsMdY9QuDI3q+JRIQrug/SChn2kiU5PthtKsed78sY6cLVDgVBIC5pqtEWbAV8SWYi6tGQpjUhHRowWeEJJjFlNUN05fzcAWBNmtzVPhk03BgVAEsI0PxPTPX3+zuya7LgzZz8bQROig8EmsNOBN7fPNcex69LK4m52GvHqlyjewpiftJiHH/oVb25+bvMXvnectDpOWvcWUXW6+FJcbdEsAysZos21vGWaZ+fwtJWnubQ+7HrZS4AtlxpCWGbDolSi+7+d6/gM7xrvoxmhtpcIqn4PhAr1pr3HmPvY/eizSkj1gaa4KJujtbHs6pUQ/s6tIvVGfUnk73pU39EzmU1OW59qzsNqTD+zd+BCtfV0pOJqnSctBk81mq2xZVq7fTh21KLUvz7kJAjL6L/ZcECM= +sidebar_class_name: "delete api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Deletes an approval task. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/delete-release.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/delete-release.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/delete-release.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/delete-release.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/delete-release.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/delete-release.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/delete-release.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/delete-release.StatusCodes.json new file mode 100644 index 00000000..e55b7aaf --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/delete-release.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"The deleted app version","content":{"application/json":{"examples":{"200 - The deleted app version":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/delete-release.api.mdx b/docs/release-management-api/store-releases/api-reference/delete-release.api.mdx new file mode 100644 index 00000000..44144ed3 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/delete-release.api.mdx @@ -0,0 +1,69 @@ +--- +id: delete-release +title: "Delete an app version" +description: "Deletes an app version." +sidebar_label: "Delete an app version" +hide_title: true +hide_table_of_contents: true +api: eJyVVtFu4kYU/ZWRpSptFHBgu6qENrtCxW3RJmxqSKQ2G0WDfcFTzNg7MyahyK/9gH5iv6RnxgZCgEjhwRjP3HPPvXPPwSsvJh0pkRuRSa/j9SglQ5pxyXieswUpjYWmd+ZlOSlud/Xjzb4QV64Jq5qiQgmz9Dp3K89kMwLY3X15f+YZPtW497qAu63gtIfnOVd8DgylXYzED+CKGGDCMsm5SXCv6FshFCGnUQUhUZTQnHsdZFnmNkIbJeTUK20uRToHPGm73j4/t1+79Y0SYrHjHj8vEImiTBqSxoZgIRWRK9b/S9u4lUdPfJ6nG2TWYMegsGHB0wLcVqX7nHk/nrf2qdxIXpgkU+Jvit+WH3DIvxP/LCmQYtuYIAwfbgbdm9FvX8L+n0EPOeakNZ/Sy+Rbmu/2aV6TmgttK0O1Uryd6ztw3Qc5Qvg6CK/6w2H/y+ChFwz6L1jvw2yot9r71IeGy5irmIEhYSzYZpjeVkKrjRKOgx0pZTjqDnrdsPdw2f85GAyDhzD4/aYfvihplAjNxiRpIswaEvLbTzfJFDMYORCXFNVD19w04P2hae+jRiV5yoakMJ4sUCpTbyv+vZv1w0BHCu8PRkE46F7u1DnMIPYESmWPyMweVeZEW7O3a5n1lUpQ3lkl/47ng1+jVpb2VyIundlYEpVvFCrFttUYNnQTXpa+qiypMecSiefI5S/avjaZoka9pv1FCygLrgQf12XW8VULJ7xI0RwvMSbXHR8cRHMs4DOamiJD6L6nVJSYhWHAYY/CJO64nF+RO6f7rU0O3VOXuTbLjZ8h2Wdarl0wIR6T2kt53R0xTIHtrloyk7ECebvXfRbxNNXYXtvpWuTufD3baSEnmcsmTGp31BbOrjb9cjgNtuPX6Nba3bxFu9naI3R6epllM3u86znN0tgifTo9ZX9kBYhJNhEyZhjzhBR12AfOEkWTi5NDZ4YuNOIs0j5C6KmZmHn6CUetm7kSc9Q8QH0XNffv2udb9viBrLjetnDpAeKEGa6mZC5OHsYpl7OTj7ctV6POKfrg849f5Vc52jLG2aUpJAmLyRVBGpAaDOcXGqvCdrulDWuft39qomczHHChCAVzw5YoM+ELYnMxVS4MB2NbIenRAY8JzbGbSTZt0lc7UIGgu41pIWJyLThQigC2zYGa/vvnX3bbZlfrQParDbQVejj4PNMG8Pbs6+E4/F//8mhXW7d45e2gHl5DT8bPU47ZRUqnzVUt5TvvuZQR0sF/PSSRgJddXVUaVmlZ2sffClL2beJ+K1Sn91hoew+vmPBU0ytkvw9rg/6BHSO4lpxcOj9wVubhdgYBuneR8h67ag3a7NVCN4ooN89C9kzUan3jab3gMhgF2G7VuKv0mVN6feNenQ4x2lXxmp69lmdHQlarykfKcrO/WjoasXGaunhbBEzrfx7edQc= +sidebar_class_name: "delete api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Deletes an app version. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/delete-staged-rollout-schedule-android.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/delete-staged-rollout-schedule-android.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/delete-staged-rollout-schedule-android.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/delete-staged-rollout-schedule-android.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/delete-staged-rollout-schedule-android.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/delete-staged-rollout-schedule-android.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/delete-staged-rollout-schedule-android.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/delete-staged-rollout-schedule-android.StatusCodes.json new file mode 100644 index 00000000..86933a51 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/delete-staged-rollout-schedule-android.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Delete staged rollout schedule","content":{"application/json":{"examples":{"204 - Delete staged rollout schedule":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Schedule not found for this release":{"value":{"code":"ERR_NOT_SCHEDULED","message":"Cannot delete the staged rollout schedule: no schedule exists for this release."}},"412 - Already released":{"value":{"code":"ERR_SCHEDULE_ALREADY_FINISHED","message":"Cannot delete the staged rollout schedule: already finished."}},"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for Android releases."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/delete-staged-rollout-schedule-android.api.mdx b/docs/release-management-api/store-releases/api-reference/delete-staged-rollout-schedule-android.api.mdx new file mode 100644 index 00000000..290dfe29 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/delete-staged-rollout-schedule-android.api.mdx @@ -0,0 +1,69 @@ +--- +id: delete-staged-rollout-schedule-android +title: "Delete staged rollout schedule - Android only" +description: "Delete scheduled staged rollout for the given app version." +sidebar_label: "Delete staged rollout schedule - Android only" +hide_title: true +hide_table_of_contents: true +api: eJylV+1u4kYUfZWRpSptFCCwW1VC+yG0OLtoCUn5iLTdjdCALzCNmfHOjEko4m8foI/YJ+mZsQ0hQKq0/ACDfc899+vcYRVEZMZaJFYoGdSDJsVkiZnxjKI0pogZy6f40CqOVWrZRGlmZ8SmYkGS8SRhC9IGtuXgLDA0TrWwy6D+dRVYdUdA/Hq7vj0LAGJwHTRgcJMZGFZiH5WaxsSuY75kPas0sS78c0MBbFRCmjtarWhDrOfZdDMyvZxkQ0ZaiQgEEq75HI9p4ylIfIGpvyVcdAm3M1xr+p4KTYC1OiXwBtCcB3WQXibOwlgt5DRYO+qaTAK2ZNz92vlr93E4Z7uZKlIIf2MlLUnrLJGxWIx9WJXfjTNfBfTA50m8cYC8/AsinlvwOHUXa/86C16fV/eJDSRP7Uxp8QdFL6MBONDYsX/kFEiRS1PY7Q4Hncag/+mq2/otbMLHnIwB6afOtzRf7dO8Jj0XxvUEi0iKl3N9Ba77IEcIX4fdy1av17rqDJthp/WE9T7MlvqB0uftyqRyo5HKF1N31d4HOUK9c9UfXlwNOruU+xhHNKlK9ZjYmEsHM6IcacO+Wttnj2mSEdcRA0lCi7PNYLwsimoNURTTuA0jFwthgJtN9TNx9T58CpuD9pNyfMjCibJ5cMJzZCbqcLv5wuhBGGv2/JeDPBWg24g18WhZ3Dqa84LXsNHuho3ml+FFq9PqffrvPHnueCKkMPjxManjBTnGrt/oNBvd5rDd+hB2euGwG/46aHXDpx2CHIxI0kTYAtIwvu+uUHcUX9LYgj9qX942Ue1AE7UkiImIJTG3sJ+/sHdqLu49jCPhtjo3jXarObxuN/oXV93L/ShJRokS0jJcKxkvWWr4KM4iy/dEUXKzDezn8/NDgWGRSB6zHmksORZqrfTLogOuj+4Q0NEQ+2G302jvhNZT2GozrCR2D8/sXiu/nXL27p5yOzJrP78HsefqQQX8Svl+NpWViNaVqd+4JSR6WTJu41ayRi3ljVp6tLaMp5ut0lTHAFyNkLdBt72u5DkszbmE+RysKotaxSOWivxWFlWgLLgWrgQ+Ibl9luwJT2OkMZhZm5h6BWxFeSSwejGpQsF0tx5O5zJKzMEw4LB7YWfZuLkV7gfc7eziINLzv3rP+XFks+Lh7DMti4PBDCNJes/ldaPPMAiuDnrJrEI3EWtctyCzcWzweH7CKDad7wQ/z0JOlPcmrFvYm0VxucmXx4EOPToRuWxll7BY1MrVPUKnp22l7lwjFKOq4sghvT89ZV9U6vTfKUvEMOkz0tCbN5zNNE3enhyqGbJQitTYVGBCD+WZncfvUWpTTrSYI+YO4nubc/+hdr5ljy/wivebKt6agDhhlusp2bcnw1HM5d3Ju5uqj9EkNH5T4e++yW+yv2WM2sWxW1QRJZowRFAbbN0LGunUZbtqLKud134pI2d3KHCqnbByy5YIc8YXxOZiqr0ZCuNSIeneA49oovzDJMvO6bMZyECQ3dI0FRH5FBwIRQDb+UBMf//5F7upscvCkH10hi7CAIVPlLGAd7XPm+P5w5xrgVyXnF49rfhqKzf/72yet72lB1vB9KPrQdZP9SqXi6/BY7mASd0fnPcUwynDEc3A6M0Qv8NaZVqh4/Xa/fw9Je3+F9xuBcHrSiS8PkO9Jjw29Ez0P3bzXfgTOxZOMdpy6XXHi2uAyzsMuv8bsL7FU/msO+/ZjcZ4TIl9ZLIn605TNirbDNthP8Tjbup3FeXOK0p+4f8EHWK0qxYFPfe+PjtislpleoVkFs9nt45abBQtD94FAXH8B6yfyX8= +sidebar_class_name: "delete api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Delete scheduled staged rollout for the given app version. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/finish-beta-distribution-on-testing-group.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/finish-beta-distribution-on-testing-group.ParamsDetails.json new file mode 100644 index 00000000..fcb02094 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/finish-beta-distribution-on-testing-group.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/finish-beta-distribution-on-testing-group.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/finish-beta-distribution-on-testing-group.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/finish-beta-distribution-on-testing-group.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/finish-beta-distribution-on-testing-group.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/finish-beta-distribution-on-testing-group.StatusCodes.json new file mode 100644 index 00000000..75936e4d --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/finish-beta-distribution-on-testing-group.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Finish testing","content":{"application/json":{"examples":{"200 - Finish testing":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - App Store Connect API credentials":{"value":{"code":"ERR_UNAUTHORIZED","message":"The specified connected app does not have a valid App Store Connect API credential"}},"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/finish-beta-distribution-on-testing-group.api.mdx b/docs/release-management-api/store-releases/api-reference/finish-beta-distribution-on-testing-group.api.mdx new file mode 100644 index 00000000..38d5ab04 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/finish-beta-distribution-on-testing-group.api.mdx @@ -0,0 +1,69 @@ +--- +id: finish-beta-distribution-on-testing-group +title: "Stop beta distribution on the testing group - IOS only" +description: "Finish the beta distribution testing of the release candidate on the given group." +sidebar_label: "Stop beta distribution on the testing group - IOS only" +hide_title: true +hide_table_of_contents: true +api: eJy9V21vIjcQ/ivWSlXaKLCBy6kSuhfRg1xRCaRAIrW5CJndgXWz2Hu2lxxFfO0P6E/sL+mMd5eXLFyFqvY+cAZ7nnlm7HlmsvJCMIEWiRVKeg3vWkhhImYjYBOwnIXCWC0mKW0zC8YKOWNq6g5oiIEbYAGXoQi5BUZncGMmFiDZTKs0qXoXnoEg1cIuvcbDyrPqCdDRw+P68cKzfGZw7TWThN2DNujEsAobWqWB/UD+Wzv+PbRQCWhOXzrhhi0d3D3Xl6OM6EdigAQSrvkcLDpwFCR+QWMR4pagoBNuI1xr+JwKDQhsdQrIO4hgzr0Gkl4mZEEu5Mxbry82IC7I8b+AeqTDJsHAwdB+/fKS/jt8K1lYiB8oaUFaOsmTJBaBy4n/m6HjKw++8HkSbwAxpS8Q8PcFj1Nkslq7fxfe1WWt7PhO8tRGSovfITzNLcKhW7rY7DY/KCkhsKx522EBZgZhBI/NLhOEDyk37cFgfNdr3o1+7A86v7Zb6HgOxvAZbY7wfZkEAjEVELIgQ8UV8mGhAsOksiziC2CcIbAI/5GDl0ePdPfCPZXZnvE2q6/KWb0FPReGXjtDDuL01L5CrmWQI4Rv24ObznDY6ffGrXav84J1GWZL/apMfZDXPGV5qlJ5MvUrpF4GOUK91x+Nr/t3vfITwJpRqQ6c+BDMBHKkDftavcx+aFGquA4ZkgSsOLap09OiqNWdSh0DOxLNcNTstZqD1rjb+dDuDdvjQfvnu86g9MCFwXAkTIUtIA0+5pK7qdJObfdqoLpNQP1AAjoyq4kk5hbt5yfGXae4SxhHwu307pvdTmt8222OrvuDm3KUIMNECWkZrpWMlyw1fBJnkYn+sGgwZhvU60Pq2MEAtOQxG4JegGZtrZU+LbLXTiQPAx0Nb9Qe9JrdvbCGCvtMRD3yGT2zZ62cyOfsaU9R3woxMAuuM2G7aHg+8qss8gbor0S49qn7Vna7r59rd8W1HDxVtJ61a7FEOGtvqY4RcjXBzN0Nums/z2JlziWSnCMvf1H3DSlipciwv6ghyoJrQRfgUpLbZ+me8jTGRHqRtYlp+MhXVCcCuRmoCoWm+zfiRDrLIcEwxGHPwmZzheuF4O70cTscDN2vznM+Imx6JTr7CZZFh42Ah6BLLm+bI4ZlQDehl8wqfEuQCT2Psc1cFA270Gj3Fpz0CzlVzpuwMexI3M0mXw4na2bFlELZypZosahXayVC5+ddpZ7oKRSFquKQkN6fn7NfVErKxaZChgzrPAINDfaGs0jD9O3ZoTvDLFRCFRgfTeBLNbLz+D1etakmWswx5h7G9zbn/k39cssev6BX/Lyv4UcLIc6Y5XoG9u3ZeBJz+XT27r7mYqTG+sbn7z7JT3K0ZYx3F8cksSEkGrCMUGuwX1zDRKeU7ZqxrH5Z/76KOXvCC06x19qIW7bEMF0vnouZdmZ4MZQKCc8OeAJT5Q6DrJLTr2YgA8HsVmapCMGl4EAoArHJB8b01x9/svs6uykM2UcypAg9vPhEGYvwdPf548AxITkw9+ZjbTH+usIjuUCJItl6efWrrfL8J/N0XhYWvlgfRRirAoNxVb/KBeXB2xUUNGm4CbWkKQS2pyp0dDPSYnVGmCKCW2VyouP1mn7+nIKmcf5xqxlOehCb1ihxU5zt4Ct5+XaQN8vv2LGIiuqXSydNToE9XD6hFrjpncbw/9HjJi/rRzybyxBFnW03gwASu2NY6jkkd5sW0Gp326M2HidB2he7Jyd2+cL9zXSI176QFSTpk/Jy0GS1yqR0vd6cz7aOWmzENk86BYG6/TeaQOBW +sidebar_class_name: "delete api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Finish the beta distribution testing of the release candidate on the given group. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-approval-task.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/get-approval-task.ParamsDetails.json new file mode 100644 index 00000000..560fc774 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-approval-task.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"task_id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-approval-task.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/get-approval-task.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-approval-task.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-approval-task.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/get-approval-task.StatusCodes.json new file mode 100644 index 00000000..80ffd1fb --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-approval-task.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Approval Task","content":{"application/json":{"examples":{"200 - Approval Task":{"value":{"description":"Long description about this task.","due_date":"2025-02-06T09:26:01.000Z","completed":true,"completed_at":"2025-02-11T09:26:01.000Z","created_at":"2025-02-11T09:26:01.000Z","id":1,"summary":"Example Task","assigned_user":null,"creator_user":null}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}},"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-approval-task.api.mdx b/docs/release-management-api/store-releases/api-reference/get-approval-task.api.mdx new file mode 100644 index 00000000..20df8e18 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-approval-task.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-approval-task +title: "Get an approval task" +description: "Gives back an approval task by task Id." +sidebar_label: "Get an approval task" +hide_title: true +hide_table_of_contents: true +api: eJy9V21vIjcQ/ivWSlXaKLxeclXR5U6o4VLUhKRAIvVyCJndgXVZ7D3bS0IRX/sD+hP7SzrjfQGy4dSoVfMBjO2ZeeYZ+xln7QVgfC1iK5T0Wt6lWIJhE+7PGZeMx7FWSx4xy82cTVbpdzeoeieeAT/Rwq681sPas2oOaP4w2oxOPMtnBsdeO47ZPWiDng2rsHbmzHi4R8WgOcXsBhQVbL46xAjoPeaaL8CitfMv8QfuEwEuCcIZcxviWMOXRGhAH1YngKD8EBbcayGiVUwWxmohZ95mc1I4oRzG/8LTiDabGJMCQ+vNep2+9nnM02FZPr6SFqSljUhqJHyXfO03Q7vXHjzxRRwV/nbYSh3gNI4TKAe6UnLGdqYYn6jEMhsK46pFpQoSGAfcUhbNevOsUm9W6m+H9R9azbeteqNar9c/OYgEwW4pKCbG3O6YNhplUw38n+xD1lsN5DZZLLjGk+N10rxzlrgxYibRUWJAey2ZRFHmXOmduY37O/FO640yIXeSJzZUWvwOweuIR3dI/J79Lu++CojBTr8/vuu174Y/3fS7nzoXGGMBxvAZPA++hfmmDPMW9EIYuhtYPSlej/UNYi07OQD4ttO/7g4G3Zve+KLT6z5DXXazhX5aht6HCLgBJpVlU5XIV0M/Rei9wvgA5N7NcPzx5q63D3UYAsPbpxLtA/O5JAwTyDxliNF7GeJ/GSXjptEsczOwXAZcBwwpAFQIVujK6zhqNDGLw84OZDMYtnsX7f7F+Kr7Y6c36Iz7nV/uuv3O8+xQGyYgYSps7tIwXg43VRqFBBlQUoKPF5waQrUg4Owl4etijlqibg1AL0GzjtZKvy75MyeALzs6kHi3N+z0e+2rvTwHCjtIiKLNHjEye9TK6XeGntYUNZ8ZWNdwsA20vBqCqyyzplVbi2BTy5sg/sxax8a1P0KVdqdER2i6nuCJu+tfbWo6PX2VBZeIZIHBa8tmzaCIQSVbM7VlA70suRZ8kuWd2aecTnkSkZqG1samVUMUojoR2IMMVIUiUd+jnU5sComRG4Z+2KOwoauf62XgCjfaNu6Bm3WRs/Zd9DoM9jOs8g4ZAg9Al0LetocMjwXRrfFloBgKNGvfdvHCRNjkT/J+myuiK7i7o0JOlYsmbAQ7gnJd8OX8uCZYvCCIrXSIFstmtVECdHx8pdSc6p0fXBUF5OnD8TH7VSV0k9lUyIDhuQ9BQ4u94yzUMD0/eqlmyEIlUL6poQk8VUO7iD5gqU011oL6Vw/zO8+wf9Osb9HjD4yKn/cN/LhAF0fYizUetPOj8STicn70/r7hcjQx+O9q/P1n+VkOt4ixdlFEkhNArMGn5spQnT/CRCfEdsNYhn32+ypyNscCJxowYW7ZCtMM+RLYQsy0M8PCEBUSHp3jCSA5tBlklYJ+lYHUCbJbmSUiAEfBC6kI9E0xMKe//viT3TfZdW7ILsmQMvSw8LEyFt1T7bPDgS+/0kPzeWHXW/F4xfs0O8oWnmwtjjieZATgbuo6u+wP3u5lR5OWexUW951m8sci3psQwZPROr3oGp8hNP0lAXrKPIy2t9mJQiAMjVFhpugLvpLTt/1M1r9jh3Dn91KunGg4AfRwOIdV+iym9+3/GDGnZTPCrZk+UNLpatv3IbY7diXFJx0qBPiyMyTaE6rJrgTNnQRlA/dfxkuY9uUlB0ifxMmLJut1KnCbTbE/XTpoUUhgRjhlgGr6NzOYeQM= +sidebar_class_name: "get api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gives back an approval task by task Id. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-release-candidate-upload-status.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/get-release-candidate-upload-status.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-release-candidate-upload-status.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-release-candidate-upload-status.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/get-release-candidate-upload-status.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-release-candidate-upload-status.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-release-candidate-upload-status.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/get-release-candidate-upload-status.StatusCodes.json new file mode 100644 index 00000000..c1788057 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-release-candidate-upload-status.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Gets the upload status of the release candidate","content":{"application/json":{"examples":{"200 - Gets the upload status of the release candidate":{"value":{"release_candidate_build_slug":null,"release_candidate_id":"336e4af8-1442-4866-baed-36475cd27c64","upload_build_url":"https://app.bitrise.io/app/ci-config-slug/build/upload-build-slug","upload_state":"finished","processing_state":"VALID"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-release-candidate-upload-status.api.mdx b/docs/release-management-api/store-releases/api-reference/get-release-candidate-upload-status.api.mdx new file mode 100644 index 00000000..a1e0069b --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-release-candidate-upload-status.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-release-candidate-upload-status +title: "Get the upload status of a release candidate" +description: "Gets the upload status of a release candidate." +sidebar_label: "Get the upload status of a release candidate" +hide_title: true +hide_table_of_contents: true +api: eJyVVu1u4kYUfZWRpSptFONASLJCm12hhd1FTUjKR6Q2G6HBvuApxuOdGZNQxN8+QB+xT9J7x8ZAgFXJD+KPueeec+/cM144AWhficQIGTs15wsYzUwILE0iyQOmDTepZnLEOFMQAdfAfB4HIuAGSs6ZIxNQnIJbQRbeyVZ9Wi3qW6CuxcH1GvxUCTN3ak8Lx8gJYNan5+XzmWP4WOO1U08S9ghKI6ZmLsvxWAHo4NqEKz4Fg6ssTow3mF0EmECQjISbEK8VfE+FAmRmVAqY3A9hyp0aZp4nFKGNEvHYWVJ+BTrBlKDpfeX8nP793+LQw53yIAFfxgZiQ1A8SSLh21J5f2rCWzjwyqdJVGREtcemwMAZj1J7kb8dFG8Hw1REwUBH6dipxWkUne1ZI6hvFxdXUOWjd265Wq241XdXV+6QQ+BeXFWvL/2gcu1fVVFORiqHTVWEkaExia55HsorDQWWU0NJSLr1fOGi/pEYu8TAs1FeBuHaG/t8DUtaqSkjEQsdAjUzUdIHrbFHxdvH+m2rgR2jvzOnel7e7VM/5qkJpRJ/WZAjmoBw2ISt+M0K+zIgCs1OZ9Bv1/u9r/ed1h/NBuaYIks+hrfJ1zQvdmk+gJoKTfucBRCL47leINddkAOEH5qdu1a327pvDxrNdusN612YNfXqLvXVUMbSsJFM46OpVzcmew1ygHr7vjf4fN9vb1Pu2YHQMlW+nQiCGUKOVLAvV3bZoxnFAVcBQ5KAE88KnzhORbmCKg6DHVDT7dXbjXqnMbhtfWq2u81Bp/lbv9VpvlUnNMqJYSTMClKjCe+kG0llvQGJx+AbCBiNYlGAy31G1kKNKuYR64KagWJNpaQ6Tvyltav9QAeEt9q9Zqddv93S2ZXo4yEOOHvBzOxFSevHOXt6J8mgxmDIDsjWaw65izvLjwhvIYKll/uaW/habjSeXh88xDA7LzLrWgwxot+5XUdPeYyspkjEm1UwVCpw83fam5URZcaV4MO8Bnl8Vt8RTyOzZYhiwxAxdLsFtHszSoxgGOKwF2FC20t7ToFt4vP6yOzapzZzfnAW5xgm+xXmq9MvBB6A2kn5UO8x3CJUejVnRrIU89YfWjg8UUQlyo/RlX/Z5jvUBhGPpM0mTAQb439X1MviuGzz7KZqZZcYMauUyjuETk9vpZxQ71ebWEYBIX08PWW/y5SmmuFpEDCcgRAU1Nh7zkIFo5uTfT3DKriB9LWHIfBaCs00+oit1qVEiSlqbqO+m5z7T5XzNXu8waz4+1jGnwZCnDDDFW66m5PBMOLx5OTDY9lq1An47z3+4Vv8Le6tGWPvoojsJ4BEAc4NziF66WcYqpSqXdaGVc4r1yWs2QQbnCpAwdywOcoM+QzYVIyVDcPGUClieLHAQ8Di0GKIS5T0hxXIQLC67jgVAdgS7JEiEJtyoKZ///6HPVbY3SqQfaFAUuhg4xOpDcJT7/PNcdQH4tuOL9YOc/yXZr7VDbwaL4k47nQkaCd5kRvDk7NpDBhSs1+EO95QfHKQLWT+gGMWolbCWGS+oKLlkh5/T0HR1+rzevithwRC0zWa04hHGn6g9OdOfiL8wg7JWI1xPLceY73TwcsJDrX9rl0+46p8ril79qLu+5CYjZAd1yb/KEz0S7OHa2m8t61jYq0jv7Df5fvobNvCihv9Ls8OhCwWmTFhJVfrs1cHIwrrypWTAnTB/wA7QFe3 +sidebar_class_name: "get api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gets the upload status of a release candidate. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-release-candidate.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/get-release-candidate.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-release-candidate.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-release-candidate.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/get-release-candidate.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-release-candidate.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-release-candidate.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/get-release-candidate.StatusCodes.json new file mode 100644 index 00000000..1a12a8f2 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-release-candidate.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Release candidate","content":{"application/json":{"examples":{"200 - Release candidate":{"value":{"artifact_slug":"installable-artifact-slug","artifact_url":"https://artifact.url","build_slug":"rc-build-slug","build_url":"https://app.bitrise.io/app/ci-config-slug/build/rc-build-slug"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-release-candidate.api.mdx b/docs/release-management-api/store-releases/api-reference/get-release-candidate.api.mdx new file mode 100644 index 00000000..e541eff3 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-release-candidate.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-release-candidate +title: "Get data on the release candidate" +description: "Gets data on the release candidate." +sidebar_label: "Get data on the release candidate" +hide_title: true +hide_table_of_contents: true +api: eJyVVv9u4kYQfpWVpSptBDhwOVVClzuhC3dFl5DUQKQ2F6HFHvA2Zte3uyahiH/7AH3EPkln1jbmR7g2+YOsvTPffDOz861XXgQm1CK1Qkmv7X0Ga1jELWdKMhsD05AAN8BCLiOBG9Dwap5KQXPy6EW5T5BbfSyN0MZAmGlhl177fuVZ9QgIf/+wfqh5ls8Mrr1OmrI70AZxDKuzAoNVIGibcs3nYNHK4Uh8wIgiwgCC+KbcxrjW8C0TGpCN1Rlg8DCGOffaGHmZkoexWsiZt6b4GkyKIcHQfuvsjP7tViHYTxpDhEpakJaMeZomInQF8P8w5LHy4JnP02SDuZVPBYJbC55kbsG1FVMe2rFJshmlJI3lScInCdTLvbrbq1W2mU7QNLY2NW3fL1836HXNm2QiiUo4HdbdcwmRb+75p2ljIrAwBhpC0aMfijrmORUz5+c7L38Xa+3+at75WfOwcCPJMxsrLf6E6HU1Qzis2Y7/drlCFVEbu0EwHvU7o+EvN0Hv9+4lxpiDMXwG+8Ermm8Oad6CngtDB49FIMXrub5BrocgRwjfdoPr3mDQu+mPL7v93h7rQ5iK+vnxoymVZVOVyVdTP986mhXIEer9m+H4082ov0t56HTBqEyH7ngTzAQKpA37ZuuQ/cDiMHAdMSQJOIJsM7ivy6LZwiyOgx3JZjDs9C87weX4qvex2x90x0H311Ev6O5nJwymI2EqbAlpGD8MN1XaSSQSlxBaiBhN1KYAb19Slh7mqCVP2AD0AjTraq3065J/69TlZaAjiff6w27Q71zt5DlQKKwxqiJ7wsjsSStZTvea7HCUSN1nYL1arrNtj0Sivig021+JaO0XF0Q93NF+4pRLdq45qwnajIKryn7OJfKYY2h/0fKNVRrqxZ7xF01EWXAtSA9d1oV/XtEpzxK7o2RiS8nQdbfodF5zSoxgGOKwJ2Fj1z13VYBr20N1aw3cWxe5uLs2VwkG+wLL8gKKgUegD0LedoYMDwUVWy+ZVSzDuJ3bHo5Lkhg0L26yUrFcuz0qvJBT5aIJm8DWwF9v6uVw6mz7+qRq5Uv0WLQazQNCp6dXSj1St8tjq5KIkD6cnrLfVEZzzKZCRgxPfQwa2uwdZ7GG6cXJSz3DKtQjFRofXeC5Edt58gFbbRqpFnPMuY/5XRTcf2idVezxAaPi710Tfy4R4oRZrvGYXZyMJwmXjyfv75ouR5NC+M7n77/Kr3JYMcbeJQkJTgSpBpwUnDxUz08w0RlVu2ksa521fm5gzR6xwZkGTJhbtsQ0Y74ANhcz7dywMVQKCU8OeAJYHDIG2aCg361ADoLVrc8yEYErwQupCMSmGJjTP3/9ze5a7Lp0ZJ/JkTL0sPGpMhbhqffF4fjvj7H9Nq8qIfmfn3LFobbwbP004XimkYqb2VUx9Pfe9tCjS9t9fh3OPY5PjDmQxyqfd52s1/T6WwaaPgQfqqF22hAJQ2uUmSlPDHwnmR+DQtt/YsdIl+Mpl047nAp6uHzEYXWfjOsHtCrmlaLnG50whNRuuRzoL+nCRg4/d4f0RZZRZbYl4dFJQrFwn7wv0dkd95Ib/a5rR1xWq1xwsJKlfb511GMjSUXmlAGq279JzhXz +sidebar_class_name: "get api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gets data on the release candidate. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-release-settings.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/get-release-settings.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-release-settings.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-release-settings.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/get-release-settings.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-release-settings.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-release-settings.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/get-release-settings.StatusCodes.json new file mode 100644 index 00000000..c97b8edb --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-release-settings.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Gets the release settings for the version","content":{"application/json":{"examples":{"200 - Gets the release settings for the version":{"value":{"earliest_release_date":"2025-02-16T09:26:01.000Z","phased_release":true,"release_type":"SCHEDULED"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - when the release version does not exist in App Store":{"value":{"code":"ERR_APP_STORE_VERSION_NOT_FOUND","message":"The app version is missing from App Store."}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-release-settings.api.mdx b/docs/release-management-api/store-releases/api-reference/get-release-settings.api.mdx new file mode 100644 index 00000000..f9492996 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-release-settings.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-release-settings +title: "Get the release settings for the app version" +description: "Gets the release settings for the app version. - IOS only" +sidebar_label: "Get the release settings for the app version" +hide_title: true +hide_table_of_contents: true +api: eJylV+1u4kYUfZWRpSptFL68H1XRfggt3l1UAtRApG42QoN9iacxM96ZMQlF/O0D9BH7JL13sIGEsCrq/vACnnvuuefOnDtZeTGYSIvMCiW9pvcJrGE2AaYhBW6AGbBWyFvDZkq7FzzL2AK0wfVVVmGd/pApmS69C09loDnhdOINUrjBGBYQuMRAlGthl17zeuVZdQeY8/pmfXPhWY4LmtdeC+GvNvAG4fFrCvRkQ6s0sALSw4iMaz4Hi2sdmsQvmFbEmEZQKRm3CX7W8C0XGpCS1TkghSiBOfeamH+ZUYSxGtl5a2KhwWSYGAy99+t1+u9UgQpxMHWkpAVpCQRVS0Xk1Kn9YQhp5cEDn2N1ZS6s9r+DY8iCpzk4HK5TAcZOiqhJzC0V5tf9V5W6X2m8HtV/afqvm/VGtV6vf0FmWYLr4jKglKaML4QZfvgctMfdoI3a0L8L72W9cajIWPLcJkqLPyE+rWiEw6Ifxe/XFamYaARhOBn3WuPR537Y+YJsLrw5GMNv4WnyHc0XhzQHoOfCkHgsBilO5/oCuR6CHCE8CMLLznDY6fcm7aDXecL6EGZH/eUh9WLTM6ksboRcnkz9JVI/BDlCvdcfTT72x73HlEduVxqV6whYxCXBTKFA2rJv+Ifsh5bLmOuYIUnAs8W2J/K0Kho+VnEc7Eg1w1Gr126F7Um38yHoDYNJGPw27oTB0+qEwXIkzIQtIQ3jh+nKc4jEJUQWYvLD6k4A/xkBOhKJiZhlKbcYPz+xbp/qvk9APnKGwghYrJAoNQMehLFMyJ1ZHpOkNRigLP0wmFwFoduix1u+5/YMJXK7Vt6ymVbzXSKq/6IgelDsERKd3lWr22lPBt3W6GM/vDxsB8g4U0JayksThuWGT9NNCwROnUIJs1P/1XOG3UGlteQpG4LGSligtdKnteCVM+fngY6WNwrCXqv7qKyhwnmVkH73mJnda+XmTsGe3imanLdgyaJpfDW9GpKrFB0wtZWI1/RLChX63ZD6tUKImtmfs0RxMxhznSLOaopLxmF3XS6vzLlEWnNkUlv4NQdVKTWtLRqIsuBakOROhCJ+I/CM5ylK5yXWZqZZQ0qiOhU4SA1UhcLQxz2gnbShxAiGIQ67FzZxO9oNZLeHaAKXN4Sh+9VlLu4J24GNyX6FZTnmE+Ax6IOUg9aI4Qkl7fWSWYW7B+8Rgw56V5qSRMV9oRwfrvtuHws5Uy6bsCnsue/lVi+H4+4m26sKqVWOZm/hVxsHhM7Pu0rducNTeIhKY0J6f37Oflc5mSqbCRkztKAENDTZG84SDbO3Z8/1DFWoxCoyNQyBh2pi5+l7bLWpZlrMseYe1ve24P6DX9+xxy+YFZ9XDXy0EeKMWa5x1709m0xTLu/O3l01XI0mg+hNjb/7Kr/K0Y4x9i5Nyf1jyDTgwUEbRH/4CFOdk9oNNCK8fPxcRc3usME5Xtxswi1bYpkJXwD6yK12YdgYkkLCvQOewky5xSCrlPS7CmxAUN3KbS5icBI8U4pAbMqBNf3z19/symeXZSD7RIFUoYeNz5SxCE+9LzbHSbfhpx1f7Szmf12ri11v4cHW0FVx0yNXd6hXhUlce/smgSFNdwt+4hPe9oLnDKLwCjxyCdZNIKuNR+h0vaafv+Wg6aJ+szMC5yexcD6MTjXjqYHvVP1jWAznn9ixOsojLZfOb5yRevjxDg+4u8yvb3BVccYp++ZFK4ogs3shBxZOXrJ11E/BiPTISax9G7lzNlJ8cH+SPEfnsUWU3Oi5vjgSslptTAqVLNdvXh2N2NpYUTlVgI74L5nupsw= +sidebar_class_name: "get api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gets the release settings for the app version. - IOS only + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-release-status.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/get-release-status.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-release-status.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-release-status.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/get-release-status.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-release-status.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-release-status.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/get-release-status.StatusCodes.json new file mode 100644 index 00000000..834ed01f --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-release-status.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Gets the release status of the version","content":{"application/json":{"examples":{"200 - Gets the release status of the version":{"value":{"app_release_status":"ready_to_release","phased_release_status":"INACTIVE"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - when the release version does not exist in App Store":{"value":{"code":"ERR_APP_STORE_VERSION_NOT_FOUND","message":"The app version is missing from App Store."}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-release-status.api.mdx b/docs/release-management-api/store-releases/api-reference/get-release-status.api.mdx new file mode 100644 index 00000000..8e5a3644 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-release-status.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-release-status +title: "Get the release status of the app version" +description: "Gets the release status of the app version. - IOS only" +sidebar_label: "Get the release status of the app version" +hide_title: true +hide_table_of_contents: true +api: eJydV+1u4kYUfZWRpSptFCCwWVVC+yG08W6tJkANQWp3IzTYFzyNmfHOjEko4m8foI/YJ+m9YxuSOKyW5ofxx8y55547c+5k48VgIi0yK5T0ut4nsIbZBJiGFLgBZiy3uWFq7t7yLGMr0AYHN1mDBYMRUzJde2eeykBzAgniAiYsAEZuPg4wEOVa2LXX/bzxrLoDDPf5dnt75lm+MHjv9RB8UoAbBMfHFOjKRlZpYCWghzMyrvkSLI51aBIfMKiIMYygLDJuE7zX8DUXGpCQ1TkghSiBJfe6GH+d0QxjtZALb0ssNJgMA4Oh753zc/o5SptSF4wbKWlBWkJAwVIROWFafxqC2XjwwJeYWhUIU/1OZBy/4mkOJfC0HD0tRiNDDTxeT62qviCXLMHfuD406Pc+jIOJj8nT35l3cd6up3wjeW4TpcVfEB+XGMJhYk/mP6YfqZgK4Ifh9Kbfuxn/MgiDP/xLjLEEY/gCngff03xVpzkEvRSGNGIxSHE811fItQ5ygPDQD6+D0SgY9KeXfj94xroOs6d+UadermomlWVzlcujqV8g9TrIAer9wXj6cXDTf0p57FaeUbmOgEVcEswMSqQd+3anzh53t4y5jhmSBNw8bLfljsui3cEsDoMdyGY07vUve+Hl9Cr44PdH/jT0f7sJQv95dsJgOhLmwlaQhvF6uLnSbrshcQmRhZjsrrkXoPOCAIFEYiJmWcotzl8emXeH8r5PQD7Z/eV+Z7FColQMeBDGMiH3bnhIkt5wiLIMQn868UO3RA+X/JGZM5TIrVq5YHOtlvtAlP9ZSbSW7AESQX/Suwoup8Or3vjjILyulwNknCkhLcWlBsJyw2dpUQKBTaVUwuzVf/2SIweotJY8ZSPQmAnztVb6uBK8dgb8MtDB9MZ+2O9dPUlrpLAhJaTfPUZm91q5xlKyp2+KGuMCLJky9aeu10JyjbICprUR8ZbepNCg94bUb5VCtMy+jRLBou/lOkWUzQwH3IRX22pwY8klkloij9aq03JAjUrR1qqNKCuuBQnuJCjnF/LOeZ6icF5ibWa6LSQkmjOBfdJAUyic+rQCtI4KSoxgGOKwe2ETt55dv3UriBpsdQAYubcucnkM2PVjDPYrrKsunmA3A10LOeyNGe5PUl6vmVW4dvCYMAzQudKUJCqPA1XzcLV3q1jIuXLRhE3hkfde7/RyOO7osTuJkFpV//VWnWa7Ruj09EqpO7d1SgdRaUxI709P2e8qJ0tlcyFjhgaUgIYue8NZomH+9uSlmqEKjVhFpoVT4KGZ2GX6HkttmpkWS8y5j/m9Lbn/0Dnfs8cHjIrXSRsvlwhxwizXuObenkxnKZd3J+8mbZejySB60+LvvsgvcrxnjLVLU/L+GDINuG3QBNEdPsJM56R2G22oc975uYma3WGBczyX2YRbtsY0E74CdJGFdtOwMCSFhHsHPIO5coNBNinoNxUoQFDdxiIXMTgJXkhFIDbFwJz+/fsfNumw62oi+0QTKUMPC58pYxGeal8uju8/5z4v92bvLv//tFyudwsPtoVuissdWbrtvCnN4bP32BxwStcdb5/5gzvkVke90iNwqyWYL0FsCm/Q6XZLr7/moOn8fbs3AOcjsXDui/4056mBbyT8Y1i25J/YoSyqrSzXzmecfXp4e4cb253Rt7c4qtzbFL340IsiyOyjKTXjJg/Z+egnf0xq5CTVY/u4c/ZR3rj/NF6i89QaKm503Z4dmLLZFOaESlbji08HZ+zsq8ycMkAn/A8qu5oK +sidebar_class_name: "get api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gets the release status of the app version. - IOS only + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-release.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/get-release.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-release.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-release.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/get-release.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-release.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-release.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/get-release.StatusCodes.json new file mode 100644 index 00000000..e72777f5 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-release.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"App version","content":{"application/json":{"examples":{"200 - App version":{"value":{"app_store_release_type":"MANUAL","artifact_source":"ci","automatic_store_upload":false,"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","created_at":"2025-02-11T09:26:01.000Z","default_release_method":null,"demo":false,"description":"Awesome release","id":"fb55ea1e-0c96-46f2-af47-7dde1f26395a","name":"1.2.1","release_branch":"main","release_candidate_build_slug":"rc-build-slug","release_candidate_id":null,"release_candidate_locked":true,"released_at":"2025-02-10T10:26:01.000Z","slack_notification_integration_id":"ceec9565-0de0-4603-92b2-255e42c2d203","slack_webhook_url":null,"status":"completed","teams_webhook_url":"https://xxxxx.webhook.office.com/xxxxxxxxx","workflow":"build_app","stages":[{"id":1,"name":"release-candidate","status":"completed","target_date":"2025-01-28T09:26:01.000Z","started_at":"2025-01-21T09:26:01.000Z","completed_at":"2025-01-28T09:26:01.000Z","disabled":false,"view_only":true},{"id":2,"name":"google-play-upload","status":"completed","target_date":"2025-01-29T09:26:01.000Z","started_at":"2025-01-28T09:26:01.000Z","completed_at":"2025-01-29T09:26:01.000Z","disabled":false,"view_only":true},{"id":3,"name":"approvals","status":"completed","target_date":"2025-02-04T09:26:01.000Z","started_at":"2025-01-31T09:26:01.000Z","completed_at":"2025-02-03T09:26:01.000Z","disabled":false,"view_only":true,"tasks":[{"description":"Do this task first","due_date":"2025-02-07T09:26:01.000Z","completed":true,"completed_at":"2025-02-08T09:26:01.000Z","created_at":"2025-01-30T09:26:01.000Z","id":1,"summary":"This is a very important task","assigned_user":null,"creator_user":null},{"description":"Do this task last","due_date":"2025-02-07T09:26:01.000Z","completed":true,"completed_at":"2025-02-09T09:26:01.000Z","created_at":"2025-01-30T09:26:01.000Z","id":2,"summary":"This is another very important task","assigned_user":null,"creator_user":null}]},{"id":4,"name":"release","status":"completed","target_date":"2025-02-09T09:26:01.000Z","started_at":"2025-02-07T09:26:01.000Z","completed_at":"2025-02-10T10:26:01.000Z","disabled":false,"view_only":true}],"timeline":[{"stage":"release-candidate","target_date":"2025-01-28T09:26:01.000Z"},{"stage":"google-play-upload","target_date":"2025-01-29T09:26:01.000Z"},{"stage":"approvals","target_date":"2025-02-04T09:26:01.000Z"},{"stage":"release","target_date":"2025-02-09T09:26:01.000Z"}],"platform":"android","store_app_id":"io.bitrise.test","store_app_name":"Test Android App","automations":[{"id":1,"created_at":"2024-05-09T15:52:21.000Z","event_name":"release_candidate_set","workflow_name":"test-deploy","pipeline_name":null},{"id":2,"created_at":"2024-05-09T15:52:21.000Z","event_name":"release_started","workflow_name":null,"pipeline_name":"inform-stakeholders"}],"outgoing_webhooks":[{"id":"a4410940-1f5e-45ec-9ce0-b47db15b210e","created_at":"2024-05-09T15:52:21.000Z","events":["release_candidate_set"],"all_events":true,"webhook_configuration_id":"c793aad3-9e6a-44b3-af7a-187d97de9f55"},{"id":"9e1817c7-ccca-4e0d-9155-0071cb07f966","created_at":"2024-05-09T15:52:21.000Z","events":["release_created","release_candidate_set"],"all_events":false,"webhook_configuration_id":"2b3c7e23-c974-4c78-84f0-200710c8430e"}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-release.api.mdx b/docs/release-management-api/store-releases/api-reference/get-release.api.mdx new file mode 100644 index 00000000..1d0ed347 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-release.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-release +title: "Get an app version" +description: "Gives back an app version." +sidebar_label: "Get an app version" +hide_title: true +hide_table_of_contents: true +api: eJy1WP2O2kgSf5WWpVPuohhsY2BAm12hGzaLLiE5hol0m41Q2y5DH8bt7W4z4dD8ew9wj3hPctXtDz4MszOKDo0Y4+6q+tVnV9feikCGgmWK8dQaWu/YFiQJaLgmNCU0y8gWhMS1lvXG4hkIqjdOIr0V1AwSoBJwSUKYC6Z21vDL3lJ8Dcjsy9fHr28sRZcSn60R8vpc8JIWvs+ooBtQ+MbQpPgDmbIImTGNJKNqhc8Cfs+ZABSoRA4oKFzBhlpDlLLLNIVUgqVL61HLEiAzZA9Sr3uOo/+d6jc6aITMQ54qSJXehqomLDTatf8p9d69Bd/oJktqbsQmx+T4ckuTHErqhVRcwEIUJlmU6D6Mpvej9yiKCsViGqqF5LkI9VLI9Otc8Q1KDUvyPEs4RWVjmkgwAFMIFUQLLYFps8edKIydgW/7A3BsPw4GdtALfDsMPa8/iL2gE2mHhAKooUPtELzXtR3Pdt25Mxh6vaHjthzH+RX3RRDTPFE1bnTJiqOcNE8SvbrhNZgzSz6A5Bsgoo6BAl7Q7QJ1wXbCQc/2e7Fn09jv2/0oAjf2ep1Bl+Le0t1uy2u5xsuF9EDQNFzhwoay9Oh9SNOIRajQIshZEi1kki9xlwht89s2vy9tZ7UqzbWEh+tDYJXr5xZz5q5zajGZYHYsUo7+LANmwTCMlqJ81lYIAcJBt4csIu2kntOxB17g2R4ax/dCL/KcTs3qAYIV5+tFLpIKrFRU5VIz4joC0ZG4WwHdyNPd1kqpTA7b7W/60yrXWjxGaNBC4mJBf5DBAxfrOOEPSFeYEYPKMsKWUGShBu/W3ilNYtcms64ho2IJamG2VLZzbe+mEW1ILc6iEvc1o7JmfrazyTFikgYJHFJmy+BhwdNkVzj28U2hlVdrteR8mYCdJXRnl+n2MrUGz1SrCfaaWk2Oz1WrU6uFvhQcC5J8iTae7fjP06bzTCchx86LtdHg5LoIwdMqc8uJWjFJ9DqJmZBKs8uhoUb/OrxKxjW8F/zULJ5oAaexr0wXmW82VKAu1lxjxT+qT4kdYZuMC0VTZfDrci8lW6bIOZcgqmQ30rg4eqe9+4QdEvr/MEMzCF9iBu+iGbBKrkB8pzG+VsHun1emF4b6sxL3aSP+4enwh4mrWyK2gYSlYOLdVN8rxfaZdVXbp2Jzsbo9s5Ad8zkuJ8+sHMfkBwc90xfaLghaxVxstPg0EpwVlVn3RXX7w3grYNjySWgpMGlw2FAGxxzfk1HBQHdsR22W7j2PzrnzAPdtp6uhud1h1xt6tVNhi13i4jT2jhoJCerodK32aXh2BOiDHa5mLDM+L1erLC9T57uAlEHchFBk1Jlk7K61jW2kWsOKJ5HuwLX1ea6WHFvpqsM4WMqivu9iy+nYbtwF2+9CaA9CbGwCvx8FbjfwXOdSz/mkFuZScNmWCIYmyaLaVpStqu/Bljhmy/yk2+oPOpRG2GNBj9q+H3Sw5+xT273pR4N+BIO427Uqa1sDcG/cftjHjjnE3eBE9sDtIlCn74aB048Hvd73KVNQXuxHL6hX1okn9MOePuyD17HDQR/7/rB/Y9/4sWN7GrIT3vgdND+WSfN5Y/mO27z43KeYAysu2L8MshfcfJAd3nxO6I+vPiGPdFSNZ7PF/XR0P//l42zy6/gWZWxAyqIanBAfYHaaMD+B2DCp71ckgpS9HGsHsTaZXAH8aTz7MLm7m3ycLm7H08kZ6iabA3S/Cb28DBM880jM8/TF0H2E3mRyBfr043zx88f76Snk+UpfyIorJsGo02wCKDnV6F2vif4OT+aIioggSMArNKkv3i/TwvVQi+vMrmhzNx9Nb0ez28X7yV/H07vxYjb++/1kNj7XDnuKAFKImapY6l6rIQ4LHLZLaIHq+qwnGa3aAN1Lk4EJ6ihSmpA7ENivkLEQXLxM+a6ZEVxmdEXxyXQ+nk3NhOCg5x3Xt3AsxeQBJZMHwc2Ao0Rf3dCtpTl2zJxkaLURnF2OJmR7z6JHM5XRCIpCXtwX9wFG1/3s/WO76jc2NEWpGxTU3nptc5ja5Zpsb/XlfEsF0z2N0bGkL+xnRgdHt1Casfp0Ztw6Hxno6CwgEc2GIB/ywNTK+MoMdsA46ethnnRn3hrJ5VSpHvygsL/BrhoXrYDiSdYQ+Wk0JxgC2rTYgipOsK8ko08TTI7E9DbV7amsT8a5ljazPiaNNKYSOErvD7W9DJ9iJlQPttBa1XjI2hazjVNAr1+/xyqvfVsFKR7BmtNPr1+Tf/BcZy1edNKIYIxj7wxD8gMlKwHx21eXfIZWsCMeyjaSwLfWSm2Sn9DVspUJprvxKer3tsT+J885oMcfKBW/P7v4dYssXpGiV3v7ahEkNF2/+vGza3SUGYQ/tOmPv6W/pfMDYvRdkujygk2OgFCfeQRr5c8QiFxb28U2DA/OfgtttkYH5wJQYarIDtVc0S2QDdNTEyRT3JgihQfDOAA0jt4MaUsLfdICBRO0rr3MWQTGBBdUwTbcyECd/vvv/5DPHvlQEZJ3mlBriF2ClXGpkL32fRkc70DJs3HouV/3hzrx9Ay1DF4F31Qb+12MXRRpcnNfpvIX6ziVkWSITQCmxApx6dV9kcMieXzUr3/PQd+5vnw9JGpxjz6/iFzF++dZWZ3/Qq4BrFIu3Zl6YOqYhY9r2BVDW31Jq3JQSy8WRmEImToiaVRQnet1QXs3nhe9+uo0zdcmzcsHM2C+BOc0hSts+lu3fhdJ9vuiiDw+1vuLpasUdZkpNU+Lvut/DHSQXQ== +sidebar_class_name: "get api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gives back an app version. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-review-status.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/get-review-status.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-review-status.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-review-status.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/get-review-status.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-review-status.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-review-status.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/get-review-status.StatusCodes.json new file mode 100644 index 00000000..3c3e8468 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-review-status.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Gets the app store review status","content":{"application/json":{"examples":{"200 - Gets the app store review status":{"value":{"release_management_review_status":"finished","app_store_review_status":"APPROVED"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - The app version review is not requested":{"value":{"code":"ERR_REVIEW_NOT_REQUESTED","message":"App Store review has not been requested for this release."}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS app versions."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-review-status.api.mdx b/docs/release-management-api/store-releases/api-reference/get-review-status.api.mdx new file mode 100644 index 00000000..89db558c --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-review-status.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-review-status +title: "Get App Store review status" +description: "Gets App Store review status. - IOS only" +sidebar_label: "Get App Store review status" +hide_title: true +hide_table_of_contents: true +api: eJyVV21v4kYQ/isrS1XaiJdA71QJ3YtQ47taTYAaQtXeRWixh3gbs+vurslRxNf+gP7E/pLOrG0gMVxFPjh+2Zl5npmdZ5aNF4OJtMisUNLreR/BGtbPMja2SgPTsBLwxIzlNjct1mTBcMyUTNdew1MZaE5mQVwYhm7x2K3F7waiXAu79nqfNp5Vj4D+P91v7xue5Q8G7z2KMwVt0IdB3/iYQi24hwYZ13wJFpc6ZxIfMKSIMYog1Bm3Cd5r+DMXGhCO1TkggiiBJfd6GH6dkYWxWsgHb0sgNJgM44Kh792rK/p3JBc2AcYRkqnnAyNGSlqQlmxxUSoil5D2H4YcbDz4wpfIqQqBHP/XJ65c8TQHutGQAjcwW3LJH2CJgWbF4lm12FsIKUwClAn0OHMea4v6o1E4nPrXSJz+Gt6rq06d7p3kuU2UFn85d2dQQ3dI7Zn9IY1IxZR8Pwxnd4P+3eSnYRj8jmga3hKMQWYvg+9hfl+HOQK9FIb2DItBivOxfo9Y605OAB754W0wHgfDwezaHwQvUNfd7KG/qkMPi3oyqSxbqFyeDf0VQq87OQF9MJzMPgzvBs8hTxLacUblOgIWcUlu5lB62qHvdOvosbFlzHXMECRg47Bdu53HotNFFqednWAznvQH1/3wenYT/OgPxv4s9H+5C0L/JTthkI6EhbCVS8N4PdxCadeGCFxCZCGmhmztE9A9koBAIjARsyzlFu2XZ/LuEu9J2fqrQvaq5kfUVAhCDMaezkLoTwP/V1da4u+PJy8SUJPuhBeu5wBy77/kj2FLjSHqjRJjjecJMMFg2r8Jrmejm/7kwzC8rVcCZJwpIS3xo6nBcsPnaZF9gZPkIBNmn/zXx8Q4wERryVM2Bo0mzNda6fMq8Nop8HFHJylO/HDQv3lGbaxwFiU4SNgTRmZPWrmZUqKnb4om4gNYr1GMpp7XRnDNimp7I+ItvUmhSe+dareLgrXNfn4SvmLi5TpFJ5s5VuouvNm2y6o195Ohveq2nZ9m+c20Vx30suJaUM5dBkr7IrsLnqeYNy+xNjO9NuIRrbnACYm7QSg0fV4A2rkFJEZuGPphT8Imro3cpHWbiEZrNfnH7q2LXM7/3STGYD/DuprfCfAYdC3kqD9h2J2UeL1mVuH2wfPBKEDdSlNKUXkQqEaHK73byEIulIsmbAoHynu7y5fz484cuyMIZau4RYtVt9WpAbq8vFHqkSpf6YdKY/L0/vKS/aZyElSGIzlmKD8JaOixN5wlGhZvL47VDLPQjFVk2mgCX1qJXabvsdSmlWmxRM4D5Pe2xP5N92qPHh8wKl6nHbxco4sLZrnGLff2YjZPuXy8eDftOI4mg+hNm7/7LD/LyR4x1i5NSfljyDRg16AooB59gLnOKdsdY1n3qvtDC3P2iAXOUVJswi1bI82Er4AtxYN2ZlgYSoVEtSHHc1gotxhki4J+NQOFE8xu8yEXMbgUHKFCSkYxkNO/f//Dpl12Wxmyj2RIDD0sfKaMRfdU+3JzfO1E+7LAm72cnHMSLve0hS+2jaKJWxqRuJbdlP3/yTvsfzTpifLIdigB7gjrzrzYQwVA7KYEKZGHTdH+Ot1u6TUquaaz9f2+x51UxMJpLCrQgqcGvsLw27Ccud+xUySqbpVrJyVOID28fcTedQfw7T2uKtuXohcf+lEEmT0wqUkzycROKT/6E0pGTpk6VIhHpxDljfsVcQzO8+6vsNF12zhhstkU+oOZrNYXn05a7BSqZE4MUOz+A/ELiXQ= +sidebar_class_name: "get api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gets App Store review status. - IOS only + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-staged-rollout-schedule-android.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/get-staged-rollout-schedule-android.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-staged-rollout-schedule-android.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-staged-rollout-schedule-android.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/get-staged-rollout-schedule-android.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-staged-rollout-schedule-android.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-staged-rollout-schedule-android.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/get-staged-rollout-schedule-android.StatusCodes.json new file mode 100644 index 00000000..d5078a86 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-staged-rollout-schedule-android.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Get staged rollout schedule","content":{"application/json":{"examples":{"204 - Get staged rollout schedule":{"value":{"schedule":[{"id":"ab1de5df-7b10-49a6-91e6-46b08395ce71","has_run":false,"rollout_percentage":50,"when":"2025-02-12T09:26:01.000Z","last_run_at":null,"status":null}],"setup_location":"UTC","paused":false,"last_paused_at":null,"failure_reason":null}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for Android releases."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/get-staged-rollout-schedule-android.api.mdx b/docs/release-management-api/store-releases/api-reference/get-staged-rollout-schedule-android.api.mdx new file mode 100644 index 00000000..ff7fa4e6 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/get-staged-rollout-schedule-android.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-staged-rollout-schedule-android +title: "Get staged rollout schedule - Android only" +description: "Get scheduled staged rollout for the given app version." +sidebar_label: "Get staged rollout schedule - Android only" +hide_title: true +hide_table_of_contents: true +api: eJylV+1u4kYUfZWRpSptFPO1SbZB+yHUsClqQlIgkbq7ERrsC57GzHhnxmQpyt8+QB+xT9IzYwNhgZWi5gcY2/fcc+6dOXeyCGIykRaZFUoGzeCCLDNRQnGeUsyM5RN8aZWmKrdsrDSzCbGJmJFkPMvYjLRBYCU4CgxFuRZ2HjQ/LQKrHghwn+6f7o8CgBhcBy0E3BUBhoXsQqlJSuwm5XPWt0oT61FK3FCAGJWR5o5TJy5Y9T2VXsGkXzJsyVgrESN7xjWfkgW6zy/xA3H+kXC6Mm4TXGv6kgtNwLQ6J5AG0JQHTTCeZy7CWC3kJHhyvDWZDFTJuOeN2rH72lGtzRoti4dkkZKWpHVhqFUqIi+o+qdxsYuAvvJplq7QXUW+A4eXZjzN/cX6JqQKVyA+qsd0Eo/D16N6LTw+46fhWZ1Ow+PTUe3nV2cnEb2ug1HCzVDnyD7mqYH8MssQxY7AFJmD5kntKHhMXPfAqnES1hphvTGonTUbp81avVKr1T4CKeXGOqghhz6ZpylqabnNTfHLlc+QzbNhqgrZgLsd/OI7lRvXgJKCByruPcMac5HmmoYa68HFekz/dxQc1+rbnbiVPLeJ0uIvil9WesCh9Bvxz2sdqditi3avN7zttm4Hv173Oh/b58gxJWN8xTaTr2m+2qZ5Q3oqjNsBLCYpXs71Fbhug+whfNPuXXX6/c51d3je7na+Yb0Ns6a+Y62Xm5NJ5Ywgly+m7lb4Nsge6t3rwfDD9W13k/IA5oNdqXIsVxZx6WBGVCKt2Ncb2+xhHzLmOmYgSdjTbOUEL1NRb0DFfrA9avqDVve81TsfXnZ+aXf77WGv/fttp9f+Vp0wkCNpLOwS0jC+nW7pwyAuKbKwC/CurAvQ2FGAjgQxEbMs5Rbx0xfqbjjdWxh75Ha6d63Lzvnw5rI1+HDdu9pWSTLOlJCW4VrJdM5yw0dpoaw0dVTArxWzFnZSq+0SBteXPGV90hhHrK210i9TB1yvbhfQXomDdq/butyQ1lcYQQnmB3tEZvaolR8lJXv3TDmznpD1PoiJ1AyqIBeWY9RUFyJ+qk78YAxR5Xlo3GCsFkMhLO06fDZjjOdaDL1cpwBcjFC0297lU7UsYDjlEuFTUKrOGlWPGC6LW525uTDjWrj6+2qU8UWlxzxPUcMgsTYzzSrYispIYEgaqgiF0M1muA1aUGIOhgGHPQqb+OXqhy35dt6vzwt9f9dnLk8Nq2GMZL/RfDnCE+Ix6a2UN60Bwy5wTdBzZhWWErHWTQf+kKYGr5dngaVFF9PINUTIsfLZhHWzdOVwV6t6eZyQPT+4uGoVl4iYNSr1LUKHh5dKPbhVsNynKo0d0vvDQ/aHyp1xsbGQMcM2T0hTk73hLNE0fnuwq2eoQhiryFQRQl8riZ2m79FqU8m0mEJzF/reltx/aNTW7PEDWfF5V8fHOSAOmOUay+/twXCUcvlw8O6u7jWajKI3Vf7us/wsB2vG6F2aOoeNKdOEHQSrwbj4QCOdu2rXjWU4JLyuoGYPaDBGNgRzy+aQmfAZsamYaB+GxrhSSHr0wCMaK/8yyYpL+t0KFCCobjjJRUy+BDukCGC7HND079//sLsGu1oGsgsX6BQGaHymjAW86325OL5z8nL9Lx3JOdW37V6sjeZ/HJ7LBW/pq61i32O9g6bfz4vSKD4Fz40CIU1/uN3yisAfxHa6BTZdAuUOa1G4hMahyt3+kpN2B/f7tRV4R4mFt+X1aW2v9B975Qj8ie2Ts9zUcu4dx3tqgMsHbHF/VH+6x1vlLnfZiwetKKLMPgvZcnPnJitzvWgP8K7b7JtG8uCNpLzw/6LsorNpEktu7vPpaE/IYlHYFCq5fL94tDdiZWSlcqcAnvgfVjuicA== +sidebar_class_name: "get api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Get scheduled staged rollout for the given app version. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/list-approval-tasks.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/list-approval-tasks.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/list-approval-tasks.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/list-approval-tasks.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/list-approval-tasks.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/list-approval-tasks.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/list-approval-tasks.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/list-approval-tasks.StatusCodes.json new file mode 100644 index 00000000..baeec5d9 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/list-approval-tasks.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Approval Tasks","content":{"application/json":{"examples":{"200 - Approval Tasks":{"value":[{"description":null,"due_date":null,"completed":false,"completed_at":null,"created_at":"2025-02-11T09:26:01.000Z","id":1,"summary":"task 1","assigned_user":null,"creator_user":null},{"description":null,"due_date":null,"completed":false,"completed_at":null,"created_at":"2025-02-11T09:26:01.000Z","id":2,"summary":"task 2","assigned_user":null,"creator_user":null},{"description":null,"due_date":null,"completed":false,"completed_at":null,"created_at":"2025-02-11T09:26:01.000Z","id":3,"summary":"task 3","assigned_user":null,"creator_user":null}]}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/list-approval-tasks.api.mdx b/docs/release-management-api/store-releases/api-reference/list-approval-tasks.api.mdx new file mode 100644 index 00000000..f0dd6aa9 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/list-approval-tasks.api.mdx @@ -0,0 +1,69 @@ +--- +id: list-approval-tasks +title: "Get a list of approval tasks" +description: "Gives back a list of approval tasks." +sidebar_label: "Get a list of approval tasks" +hide_title: true +hide_table_of_contents: true +api: eJzVV+tu4kYUfpWRpSptxD1Jq6LNrlDDZlETknKJ1M1GaLAPeIqZ8c6MSSjibx+gj9gn6TmDbSCGqvlVdX+wtmfOd75zP1l5ARhfi9gKJb2mdy0WYNiY+zPGWSSMZWrCeBxrteARs9zMTMUreQb8RAu79JqPK8+qGaDs49P6qeRZPjX47LXimD2ANghrWJm1Ugjj4R0Vg+aksBOgyhvUkh0PSAHix1zzOViUdxokvuBNEeCRIJoxtyE+a/iaCA2IYnUCSMsPYc69JnJaxiRhrBZy6q2JmQYTIxkwdN6o1ei/feMzFiyj4StpQVq6iT6IhO9YV38zdH3lwQufx1EOuGNmioDf8SUBZ8SeLplEUckLEhgF3EL27ivCs2TQBH0FO19G3Oa3NPDsC+ptXJRrjXK9Pqj92Gx836zVK7Va7TN5CmHq6JRkPucaQ+VR+FgdT7gxYioRIjGg92CV3vm2Lv1HrBsF1o3/AeuzAuuzN7B+WtO/kndeqxczcyh5YkOlxe8QvC0vEQ7zck9+m5UrRAqoTtq93mjYbQ0Hn+56nc/tK9QxB2P4FF4rX+c0z4o070HPhaGaZwFI8XauZ8i1CHKE8H27d9vp9zt33dFVu9t5xboIs6V+XqTegwi4ASaVZROVyDdTP0fqRZAj1Lt3g9HHu2F3n/IgBIZdSiXaB+ZzSTBjSJFy9vVGkX3fchlwHWDL9gF7HMs749usqDfQiuNgR6zpD1rdq1bvanTT+and7bdHvfYvw06v/do6gZMFJEyEzSANTpmCuonSzKIrkLgEH6uPBlAld8DFodbdQRu1xMbbB70AzdpaK/024y9cBz8MdMTwTnfQ7nVbN3t29hVOrhDHDntGzexZKzeBUvZ0pmjsTcG6QYeDrOlVkVx5kY7L6koE6yrPJyaNW+KymYWJjlBgNcY8G/Zu1lW9ybnynEvUP0eV1UWjarC7QDk9M9UFdf0F14KPU2tT+Y0nJzyJqMGF1samWUXdojIWODsNVIRC0X1nU55uKDGCYYjDnoUNXdTcDAYXrqftotB3X53mdF3IZzQq+xmW2WQPgQegCyrvWwOGyUBO1ktmFcPOyVr3HSyTyLkoXRGyTuXC7JHDhZwop03YCHYK/Tb3l8NxszvfWMhbm0eUWDQq9QKh09MbpWYU5SxdVRQQ0ofTU/arSqh+2UTIgGG2h6Chyd5xFmqYXJ4cihl6oRwo31RRBF4qoZ1HHzDUphJrQSOli/Zdpty/adS27PEFteLvQx1/rhDiBPc0jel1eTIaR1zOTt4/1J2NJgb/XZW//yK/yMGWMcYuiqjRBBBr8GneMeyaH2GsE/J2HbdAHH0/VNBnMwxwogEN5pYt0cyQL4DNxVQ7MQwMuULCswMeAzqHLoOskNJ/9MAGBL1bniYiAOeCA6YIxCYdaNNff/zJHhrsNhNk1yRIFnoY+FgZi/AU+zQ5rsGao2vt6wivtr3j327FaUJbeLHVOOKYz0jD1esqLfRHb7fQUaTpdlq+ux2HyJturjY1rqP1mj5/TYAWi8enbSFv1kph6Hm7xhy14tte2se/Y8fIZiUpl65fuI7n4eMMlpv9G9eUUlajpH1z0PJ9iO2OSKHXUi/IW991e0BGJ+SR3TYwc20gfXB/WRyis1/iGTf6pc3voMhqtWky6Mns/uboqETehlLLyQLsaH8DJIR7lw== +sidebar_class_name: "get api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gives back a list of approval tasks. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/list-outgoing-webhooks.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/list-outgoing-webhooks.ParamsDetails.json new file mode 100644 index 00000000..6f79a435 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/list-outgoing-webhooks.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"description":"The UUIDv4 identifier of the app version.","schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/list-outgoing-webhooks.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/list-outgoing-webhooks.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/list-outgoing-webhooks.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/list-outgoing-webhooks.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/list-outgoing-webhooks.StatusCodes.json new file mode 100644 index 00000000..4e5cd631 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/list-outgoing-webhooks.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Outgoing webhooks","content":{"application/json":{"examples":{"200 - Outgoing webhooks":{"value":[{"id":"c71c1a5a-afe5-4129-a1a0-c3e1df2e3765","created_at":"2024-05-09T15:52:21.000Z","events":["release_candidate_set"],"all_events":null,"webhook_configuration_id":"5623239f-28ea-4b8d-856e-8cb50073fade"},{"id":"75813a9f-33ce-4789-867c-3935f0aefe96","created_at":"2024-05-09T15:52:21.000Z","events":["release_candidate_set"],"all_events":null,"webhook_configuration_id":"5623239f-28ea-4b8d-856e-8cb50073fade"}]}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/list-outgoing-webhooks.api.mdx b/docs/release-management-api/store-releases/api-reference/list-outgoing-webhooks.api.mdx new file mode 100644 index 00000000..bb07749d --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/list-outgoing-webhooks.api.mdx @@ -0,0 +1,69 @@ +--- +id: list-outgoing-webhooks +title: "Get a list of outgoing webhooks" +description: "Gives back the list of outgoing webhooks associated with the given app version." +sidebar_label: "Get a list of outgoing webhooks" +hide_title: true +hide_table_of_contents: true +api: eJzNVu1u4kYUfZWRpSrtCgM2IR9odyvU0BQ1S1Igqbq7ERrsazyNsb0zY7Ip4m8foI/YJ+mZsSEJkEr5Uan5QQyee+45986cO0snJBVIkWuRpU7HORcLUmzKgzumY2KJUJplEcsKPctEOmP3NI2z7E4xrlQWCK4pZPdCx3b1DMEp43nOFiQVAOtOzclyktyg90PgXwDwsgL7tcLCIkVBIYV+cDqflo7O7ghcPt2ubmuO5jOFZ6cL1JsSVTn4PeeSz0njFxuT4gvgRQgwYYTkXMd4lvSlEJKQWsuCaltqxyB9fd0/WxwyEVKqRSRIGr1GzZYOFcQ0504H/B5yk0tpCRHOyrCUpHIQI2Xe+82m+fc81eV2BQEZZKlGVrMYyRIR2Do1flcmYunQVz7Pkw0mc9kuCF4teFKQLYIwFQ6OvcDjbe7yiNruoeefutzjTTdokRdGPrWOj9omtyTTvAlHeqD7h26z7TZPx1670/Y7vldvNpsfsY7QUm07ICkhrmgS8DQUIYInirRpBU+SyXpZWiRJzanoTSAwErOi7P/E0msf+S2/dRq5/glx93B6Eron7SNyT4Jpu9k8bkU8JGdVq8Qct0+8FsfqVisg9/D45NQ9OToO3NZpqx01OUV0evS/F3O7Mn8157Dp7e6L65QXOs6k+IPC120JwGFLPIt/3A1LIIVml/aGw8n1oHs9/uly2P/YO0OOOSnFZ7SdfLWh2dqleUVyLpQ5CwwHRbyeawtcd0FeIHzVG37oj0b9y8HkrDfob7HehdlQ9/xd6iONHnMZwswCwhllG094nQTPh4SXwV6QMhp3B2fd4dnkov9DbzDqTYa9X677wy1J41jAdSmlSOg1JDx2N12USWtOIJ5SYNwXvOubArT3WU8fGmXKEzYiCUNjPSkz+TrxbWs/+4FeEN4fjHvDQffimc5RBs+OSwdLNbuXmXXQir15l5lzNcNZrJUW3nEaIOdWRqwaSxGuGutx5N4/HSGGUzkNCpkgcDnFCb8eXqwa1Wl35zwFjzlSNxZ+Q+lMklu9U42FB5QFl4JPK9VVfFnRiBeJsZdY61x1GmAl6lOBGaCoLjJn32gpKTEDw4DzOCjtLCHbttvH4Teyv9rM1QjczBok+5ke1rMtJviK3El51R0zbApTbPnAdMYK5O1e9VkAUzMlqobk+szbdjum8CKNMptN6MSsGJY1YR829bI4Lns2hVGt8hERC7/u7RB68+YCzTHdXm/bLAkN0vdv3rDfsgLEUhaJNGTY9TFJ6rC3nMWSoncH+3qGKrhhFqgGQuhrPdbz5Hu0WtVzKebQPIC+dxX3b/zmI3t8QVZ83nj4OAPEAdNcYpu9O5hME57eHby/8axGlVPwtsHff04/p+NHxuhdkuCEwnFySYG998B/fqSpLEy1PdyTMHiO66jZHRpcSIJgrtkDZMZ8QWwuZtKGoTGmFCndW+ApoThmMaV1k/RfK1CCoLrurMCNxZZgjxQBbJMDmv7+8y9247MP60B2bgKNQkxZJ8+UBrzpfbU5zkkb43nx4lff7vLy0Uf+g9tjtf81fdWNPOHY/mBtj/ey8odPzlN/QEjHXgJ3LQInLYZcE7EsrUEmq5X5+UtB0lw9bx/Pv7WRUCjzDEeKeKK2b49PhX87rMbAd+w1d8q96tZHPn2wfmSd1cHjHQzA3nBxoaitPcDQLF90g4By/SRkx9ON12ws9rw3xlpjBc9t5s7aTPVgb+P76Dy3kDU382mubntDlsvSxFDy9fry1YsRG5urlKflVeofGRpMnA== +sidebar_class_name: "get api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gives back the list of outgoing webhooks associated with the given app version. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/list-releases.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/list-releases.ParamsDetails.json new file mode 100644 index 00000000..85558cdc --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/list-releases.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"app_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"items_per_page","in":"query","required":false,"schema":{"default":10,"maximum":50,"minimum":1,"type":"integer"},"description":"Specifies the maximum number of app versions returned per request"},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer"},"description":"Specifies which page should be returned from the whole result set in a paginated scenario"}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/list-releases.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/list-releases.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/list-releases.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/list-releases.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/list-releases.StatusCodes.json new file mode 100644 index 00000000..7833c51b --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/list-releases.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"App versions","content":{"application/json":{"examples":{"200 - App versions":{"value":{"count":2,"items":[{"app_store_release_type":"MANUAL","artifact_source":"ci","automatic_store_upload":false,"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","created_at":"2025-02-11T09:26:01.000Z","default_release_method":null,"demo":false,"description":"Another awesome release","id":"fbaf4e63-638f-4f40-a00b-9ec1ef3d231a","name":"1.3.1","release_branch":"main","release_candidate_build_slug":null,"release_candidate_id":null,"release_candidate_locked":false,"released_at":null,"slack_notification_integration_id":null,"slack_webhook_url":null,"status":"in-progress","teams_webhook_url":null,"workflow":null,"stages":[],"timeline":[],"platform":"android","store_app_id":"io.bitrise.test","store_app_name":"Test Android App","automations":[],"outgoing_webhooks":[]},{"app_store_release_type":"MANUAL","artifact_source":"ci","automatic_store_upload":false,"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","created_at":"2025-02-11T09:26:01.000Z","default_release_method":null,"demo":false,"description":"Awesome release","id":"a6347d7b-f8e1-4b48-bd39-18b5c60da288","name":"1.2.1","release_branch":"main","release_candidate_build_slug":null,"release_candidate_id":null,"release_candidate_locked":false,"released_at":null,"slack_notification_integration_id":null,"slack_webhook_url":null,"status":"completed","teams_webhook_url":null,"workflow":null,"stages":[],"timeline":[],"platform":"android","store_app_id":"io.bitrise.test","store_app_name":"Test Android App","automations":[],"outgoing_webhooks":[]}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/list-releases.api.mdx b/docs/release-management-api/store-releases/api-reference/list-releases.api.mdx new file mode 100644 index 00000000..97b17cd2 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/list-releases.api.mdx @@ -0,0 +1,69 @@ +--- +id: list-releases +title: "Get a list of app versions" +description: "Gives back a list of app versions." +sidebar_label: "Get a list of app versions" +hide_title: true +hide_table_of_contents: true +api: eJzlWG1v2zYQ/iuEgCFbYdmS7bwZbQdj8TJjiZvZToA1DQRKOlmcJVElKTuZka/7AfuJ+yU7UvJbHBdNu09dPhgSxbt77u7h8S4LKwQZCJYrxjOrY52zGUji02BKKEmYVIRHhOY5mYGQuEXWrZrFcxBUC/RDFLnAXUNIgEqQ+FFCUAimHqzO7cJSfAqo9vbu8a5mKTqR+Gx1Ud1Npc7C9ZwKmoLCFSOT4QuqRaMeC1Eh07g+FiAe8EXAx4IJQLtKFIDWghhSanXQ1EOuxaQSLJtYj4+1lSamIJUeYvZyOoH9GiOayC2VIUS0SJTVcZ2aldJ7lhap1TnULywrX9za0jDLFExAWI+1JyEd5RCwiGFYVQykUkOyIvVBPI0uEaAKkUFIEC7R0EAqa8OXL/bgSzHPYxbERJslMuZFEhIf1igjwVPj1jzmiV6XaI1IUIRlSCAUYxlVuFEGkFHBuKWJgNtydBbpghCbjlMi3bTf3YgJehhwBJopvQ+jlbDAsK/xh9SbFxbc0zRPVuqITbbkcXVGkwL0Q8ALradZK1lhCKeZJhUX4ImSxl4Vnsvu4Lp7gfapUCyigfIkL0SgPwVMLxeKpwglqMSLPOF0nQZEnUGA3nsVlztW1AqDyDlt2+1TcOx25J/a/pHftoOg2Tw+jZp+K9TpDQRQI4dQ0aPmoe00bdcdO6ed5lHHceuO47y3asv0rnDjKYo52smKJNFfU74C8yS+GcesCULnIHmqE2cUaGYZmD6N2nDUso9aJxHCbDs2dRzfPoXABfSh2XIp7q046dZbddfwsEThC5oFMX5IKfJ0vR7QLGQhOub5BUtCTybFZIl1dw8L939LeDDd4Hu1oYxXKSMTLGEeeoksLtniGbKL6jnc3jgHP+Z86hUiWX1QVBXSHBI7F3yCpNVUVECxmDyzf87FNEr4fEN+oil5qysfSyFhGZRveUJVxEWqi1wWCm6qXMmgFVEYr/sMS5mEutIlYHNDFfYxrpNuqUATfoOQhvXaFC/UhGM9XAI2y7qc/B85/zzX6VGrfRwe+3Z0Aq7d9tsnth+2Tm33xD8MjpyQNk9ONrne/Ja5HnBdSDEN3wjT7x7NX81qO+7uLXOdoZqYC/ancfgFtwyqw1tmS377lgk17t5w6F0PutfjX94N++97Z2gjxSqir/AnxtcwW7swr0CkTOq7jISQsZdjbSHWXSV7AF/1hpf90aj/buCd9Qb9J6h31aygu81d6COFeacixFYSGwAJZNWrvMwFt4ku7Fe2x5XRuDs46w7PvIv+T73BqOcNe79d94dPXBrHDDteyCBiaqlSYvOyYw6ZbHqdVY3TrVt9FYDD5xqZPvooMpqQEQhsSEhPCC5e5vyh6WieV7TH8f5g3BsOTBlf+zniulTiESFztEzmgps+uUK/LKPWBPQZzKnSVa2B4OyNRkwa42XbZCqCtfCxGl0PLx4bVWWyU5qhwRRtNGbNhjnMdvVNNma6eM6wE6R+5V4lv9WtWrFSuew00DxbVQdsHp+W9DFmo4REtBqCesicqdikyXTBYPJztx5LRmbVWK6Gk9XogMZ+hYdldx0DDUHsmLzqjglmX0dVPBDFSYF2u1d9EtAkkeuLYnm4TV71OIJaI26sMZXoHdXMRC5X8TJ6yub1Zh3zKvwoMSvvnm1Ar15dYLnTaV3yk2OTjpp+fPWK/M4LBJaRiGUhQXpjzwcd8pqSWED05uC5nGEU7JAHsoEicF+PVZr8iKmW9VywFH0eoH9vKuzfNZ01enxBq/h74+LPGao4IIoK5NObA89PaDY9eHvjGh8ljhevG/Tth+xDNl4jxtwliZ4vQsgFBGZwwELzM/ii0NF28RrAzuC4jjGbYoILAegwVeQB3YzpDKcrpm89FMPE6FBkMDeKfcDg6M2Q1bXRT0agVILRtScFC8GE4BlXGOrWNtCnf/76m9w0yeVSkJxrQe2hHq1yLhWq17mvyHEOSu6Zr5/md7EuFZ83nFdkVnCvGnj/IpcRgjmri+pU31pbpxoPR4wI9fqiPM0ieXzUy+WAqc96yKQ+sOHzrdUmxu+HVVH+gewDM8VDtjHfVwXMMmPu5xv6+rH6k/B2/mnw1TD/60n6k/B3QN+ty245AywLnE5vKdMNAsjVhtTOzaS1rC6K8964bMTi7Ro6NTW0ejD/BKo+ZQ+burfq4xK2/tXxfVZksSgrNJJzub/8tFdiVcOrnGoP8Dr4Fwl3hV8= +sidebar_class_name: "get api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gives back a list of app versions. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/list-testing-groups.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/list-testing-groups.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/list-testing-groups.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/list-testing-groups.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/list-testing-groups.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/list-testing-groups.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/list-testing-groups.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/list-testing-groups.StatusCodes.json new file mode 100644 index 00000000..d1b68f69 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/list-testing-groups.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Testing groups (ios)","content":{"application/json":{"examples":{"200 - Testing tracks (android)":{"value":{"internal_tracks":[{"name":"internal","version_code":null,"version_name":null}],"closed_tracks":[{"name":"closed testing 1","version_code":42,"version_name":"2.1"},{"name":"alpha","version_code":null,"version_name":null}],"open_tracks":[{"name":"beta","version_code":null,"version_name":null}]}},"200 - Testing groups (ios)":{"value":{"internal":[{"id":"c3700912-5944-4c1d-90f6-eae70addbe7f","name":"Internal Testing Group 1","created_date":"2023-01-29T08 =>44 =>07.961Z","is_internal_group":true,"has_access_to_all_builds":true,"public_link_enabled":null,"public_link_id":null,"public_link_limit_enabled":null,"public_link_limit":null,"public_link":null,"feedback_enabled":true,"ios_builds_available_for_apple_silicon_mac":true,"ios_builds_available_for_apple_vision":true,"beta_testers_total":2,"beta_testers":[{"id":"87229c70-882a-4357-8620-b434110cf120"},{"id":"4224084a-a830-46e1-82e7-331345b92c40"}]},{"id":"da6acbc2-5386-4908-95db-d1cff8c757f1","name":"Internal Testing Group 2","created_date":"2023-01-29T08 =>49 =>53.183Z","is_internal_group":true,"has_access_to_all_builds":true,"public_link_enabled":null,"public_link_id":null,"public_link_limit_enabled":null,"public_link_limit":null,"public_link":null,"feedback_enabled":true,"ios_builds_available_for_apple_silicon_mac":true,"ios_builds_available_for_apple_vision":true,"beta_testers":[]}],"external":[{"id":"f0c739e4-4d2e-4c18-bebe-5ca2c284f222","name":"External Testing Group 1","created_date":"2023-01-29T08 =>44 =>52.922Z","is_internal_group":false,"has_access_to_all_builds":null,"public_link_enabled":true,"public_link_id":"HFoiPjcV","public_link_limit_enabled":false,"public_link_limit":null,"public_link":"https =>//testflight.apple.com/join/HFoiPjcV","feedback_enabled":true,"ios_builds_available_for_apple_silicon_mac":true,"ios_builds_available_for_apple_vision":true,"beta_testers_total":2,"beta_testers":[{"id":"87229c70-882a-4357-8620-b434110cf120"},{"id":"400bbd4f-9311-4db0-9baa-ac1227690c1b"}]}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Invalid Google Play API credentials":{"value":{"code":"ERR_INVALID_CREDENTIALS","message":"The specified app does not have a valid Google Play Store API credential"}},"401 - App Store Connect API credentials":{"value":{"code":"ERR_UNAUTHORIZED","message":"The specified connected app does not have a valid App Store Connect API credential"}},"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/list-testing-groups.api.mdx b/docs/release-management-api/store-releases/api-reference/list-testing-groups.api.mdx new file mode 100644 index 00000000..b7d76a0b --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/list-testing-groups.api.mdx @@ -0,0 +1,69 @@ +--- +id: list-testing-groups +title: "Get a list of testing groups/tracks" +description: "Gives back a list of testing groups/tracks." +sidebar_label: "Get a list of testing groups/tracks" +hide_title: true +hide_table_of_contents: true +api: eJztWNtu20gS/ZUGgUUuMCWSoizJGGegjRWPMI7ilWQDOxmDaJJFqWOKzeluKvEKet0P2E/cL9nqJiVZNyfC7MM+bB4Ymd116tSlq6u4sGKQkWC5YjyzLqxrNgdJQho9EkpSJhXhCVEgFcsmZCJ4kcu6Ergsa9aZJSEqBFNP1sXnhaX4IyDE54flw5ml6ETib6ub5+QehER0SWwyUlwA+SsoSq4QXLCwMIpRgucgqP6jHyOPG1wdl2qvjVbUllNBZ6AQzejL8A/cyWJcYpp7TtUUfwv4o2ACEEWJApBkNIUZtS6Q4VOuJbTebGItNU8BMkdqIPW65zj6v22PjLeMJ68Zl29QS8QzBZnS+2mepywy3OtfpBZaWPCNzvJ0DYumr3BK75HXNIsFZ/EbvWNO0wL0D4agIqNpUO7asrNaQt3z0qFBxGNcyYo03bwrd+t32rwo5RLiA2jlwjqy7h6q7+1iWl7NtZZnawia5lN6EhsMcXaAS4jpcALOcnm249Kt0Bxyp9HGdF5FjZbjdFzPbnZ83/YjN7Y7TnJuA4WWQ+M4hFaCXCpm/Up+rcnkovFWJIAqdG2MT+0bx2vYjmt7nbHTJpfvfB8fTqvWOXd/0/kpg3VoDdtVck6pDGgUgZSB4gFN0yAsWBrL1XpehJhbQcqyxwAyGqY6r0vfPF9iB9+mbMbUS2Jmw4GF1asEINa1YINRskJHVzwDOqcs1YtBwkWgjwIEkiEQRm1Gox+UmDNpTlu5WSdEoFMTo49uUTqA3vbrTUTbLc/rRC3Hbrc9avuNZstun3uOHfoN33WdKHE9x6St2e17nu+0fWrTdsOx/XNw7bYHLbvRcBt+M+x4kY+7H9b7Y3pOozDCfGm0z22/47TtTjMO7diNkqQdtZqtxP1uvng/kC8dfDQbNbfd+H++/Jl8WV1A8G336CdO1Gp0AE997IE++m07hBDsZkS9yGv7ied5m1D2vv2po9/0ah3POxLKhKbyxVjue37HobuxtH75wNntl+jeejGileIfC6k1VQqr6uW7el37NknZZKpqxv+1iM/qXzjL6s/0/g8E/79dLBwnDGM/sTsN18W0CR27E1KsHZHrea3zjhO5oS4WeCXpf2co4O43EHcZLdSUC/YPiE9rHBAOb7l+hvcZi8k155MUyG1Kn0j3tk8wDWMEYhjTrUuvvD+t3nAY9Af33Zv+VfB+2LvqDcb97s0IGcww4+hE7xlPgcgcIpYwbAaQDok5tn8ZV2RK54At4L7qsoXbJmBVxiNb3fCVW97zLINI/SjXu0H3bvzLp2H/t97VCySjEvVFut/j8IzuVnBOZbYlvMmBxn4O3IKYManTliAHdnoiNJDrPsgRwre94cf+aNT/NAgw7P0d1vswG+r+PvUhpEAlGC8nvMhOpu4j9X2QI9QHn8bBh093g/0UwE6dFyICEtFMw4RQIa3Zu94++5HCPpuKGGeZCLDPJ+vp4DQrXM9ML8fAjlgzGncHV93hVXDTf98bjHrBsPe3u/5wL8EZjlyQQcLUClJiMu+pwxJIFLpi6wzU1g5oHhpf1i3JCAR206QnBBenGd80zfZhoKOFZ9wbDro3W3aOOE5vU32XfkXN5KvgZgqr2Os1rqvuBJQZ9nCYu7DqSM6upgBZX7B4WdeV3Y6fTY/1aoqxJ6tJURqKZd0vBF4I1iLE9Lsb3izrokxFe0YzpDVDJvW5V5e6XNjVmqzPzUBEBdNXj3FCJV86OKFFqlY35EUdSbJayJCQhBrjKLozQuoKVnpNwxDEIV+ZmppgmvEUTBQfNhP1yLw1mqu5ej2+orJf4Wk19E6BxiD2VN52xwRzRPtePBHFSSGroo19hty0OasCZqJv6iLLEm60MZXCs/P/ce0vg1NW+tVovxnfUGKuB8VdQm/f3nD+qIO/ymKexhrp57dvyd95oY81SVgWEzwEUxBwQX6iZCoguXx1KGboBTvmkayjCHyrTdUs/RlDLWu5YDO0eYD2XVbc/+I5G/b4B2rF572LjyuEeEUUFZh1l6+CMKXZ46t3966xUd86P9Xpu9+z37PxhjHGLk11/YkhFxDpXpBgMf0AoSi0t12pCDaFrRr67BEDXOBFpKZUkSc001xUMzYRRgwDo12RwVcDHELCzWbIalrpix4oQdC79qRgMRgXHDCFIbbWgTb9+5//Ivce+bgSJNdaUFuIPY+Vc6kQXse+So5rUPJ7n4F2A73YVJYTPyZV6a2wc6/nKcXsRlLm9C6qavDZel4NUOTCfPzZKwgabLsk4MmaonkaYlGWApEul/r1HwUI/f3qYXPeTdlAvO2m+aiVr4fVLfCGHLNidXKzJ1NWTL208OcjnmPzBUtPnKujrLWXC10cDnL1TGSvUuuSsS6c170x7tUnertaPJpqUf0wX+oO0dmuBCtu+qn74YMii0VZi9CTq/3l0lGJdbWqLNcWYOH7D+TtAn8= +sidebar_class_name: "get api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gives back a list of testing groups/tracks. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/list-what-to-test-descriptions.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/list-what-to-test-descriptions.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/list-what-to-test-descriptions.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/list-what-to-test-descriptions.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/list-what-to-test-descriptions.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/list-what-to-test-descriptions.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/list-what-to-test-descriptions.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/list-what-to-test-descriptions.StatusCodes.json new file mode 100644 index 00000000..7918a351 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/list-what-to-test-descriptions.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"What to test","content":{"application/json":{"examples":{"200 - What to test":{"value":{"primary_locale":"en-GB","localizations":[{"id":"cf6683b7-f2d5-4100-889b-9df79f95ec37","whats_new":null,"locale":"ar-SA"},{"id":"a9da723c-b937-4210-91be-cc622c2499dc","whats_new":"Test API call","locale":"en-GB"}]}}}}}},"400":{"description":"No release candidate","content":{"application/json":{"examples":{"400 - No release candidate":{"value":{"code":"ERR_BAD_REQUEST","message":"There is no release candidate chosen"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - App Store Connect API credentials":{"value":{"code":"ERR_UNAUTHORIZED","message":"The specified connected app does not have a valid App Store Connect API credential"}},"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/list-what-to-test-descriptions.api.mdx b/docs/release-management-api/store-releases/api-reference/list-what-to-test-descriptions.api.mdx new file mode 100644 index 00000000..45551879 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/list-what-to-test-descriptions.api.mdx @@ -0,0 +1,69 @@ +--- +id: list-what-to-test-descriptions +title: "Get a list of 'What to test' descriptions - IOS only" +description: "Gives back a list of 'What to test' descriptions and the default locale." +sidebar_label: "Get a list of 'What to test' descriptions - IOS only" +hide_title: true +hide_table_of_contents: true +api: eJytV+1u4kYUfZWRpSptFENwks2C9kPswqaoCUmBpGo3ERrb12E2ZsY7HpNlEX/7AH3EPknvHZuvNWyL1Pwgxuaee86dmXOvZ04IaaBFYoSSTsO5EBNImc+DJ8ZZLFLDVMTund9G3DCjmIHU3DtsLSZlXIbMjABvRjyLDYtVwGOoOEdOCkGmhZk6jY8zx6gnwAwfH+YPR47hjyleO80kYXegUwvksr5RGtg7MJy1MLcWfmZ5YYRKQHP60gmR5iU+JU4DNUBGrTU6mDbhmo/BIKxNLPELhogQHwnSmHAzwmsNnzOhAeGMzgDZBiMYc6eBVKcJRRAB+ejMibCGNEF0SOm5d3xM/zYrt14iRA+UNCAN/Y4nSSwCS776KaUfzxz4wsdJvIRD7RvxeHfC4wzoItFizPV0mNcVM4F0L95hCntDfOW5bpIqqDZB9OLFyxP/3I288Mw9rR0fuy9f1n23Hkbn9ah+BsHJOUY/Y750KOHZacgsjgs4wufa7Ted+VGBx+shP/dOAtevn5y7p17t2K3XfHCD4IXnBd5pvR4Gm3gOLQpr3nQYIsbOGnROff4wt39Hzum2SnYV0xADTwHjZShCbmC/ip7aim7FWa9soEIi1e71hu+arWGv/ettuz/AVGNIU/5IzwYjwB0pUia3gLFgpFLc1Cs1tbKaW8kzM1JafIVwXxU1VEFHJD8X75WUEBSFxY2LMILH6S5Jt93m7eDn617nj3brW00sTSAQkYCQBTkqXiEfFiogrYaN+ATQAhBYhP/KwSnUI90Nufsy2wheVfWkXNUb0GORkm+g70ixf2lPkGsZZAfhm3bvqtPvd667w1a72/mGdRlmRf20TL1XbCOqcqQyuTf1U6ReBtlBvXs9GH64vu2WtwBamsp0YPczwfhQIC3Z17wy+77B3c91iM0hADREtrTR/VTUPOv3u8B2qOkPmt1Ws9caXnbet7v9tj2znV5pg+OB9UFCJMwCEvtUOV2ktG1dG2egsiqAt6UAHZmfiSTmBuPHe+r2SHcJY4fcTveuedlpDW8um4MP172rskqQYaKENGRRSsZTlqXcj3Nl4rq/8Kx0Jepsm+V2UICWPGZ90BPQrK210vspO7Oeux1op7xBu9dtXm7I6ivs3SNsvOwZM7NnrWwPLtjTM0Vd6RGMbfXYyhtOFcm5k2KOqM5EOK/6OES44doQUaUG5RrlFg06tQTzvpnpGFFmPlbqtnc5rxZVc8dcIqkx8qhOvGpKDuguKlqd1BBlwrWggtsSFPF5ee0whKgjY5K0UUWKouILpJNCRSgM3VwBa8p5zQiGIQ57FmZk96cdTcCu4cNqrOrbuzZzMVwtRxdM9gtMFwPPCHgIupTypjlguO2p8npKo0eGeRddmwapYnJaeLJde2v1QkbKZhPGtvWFG10t62Vx8ua1mO+oWvklRky8Sq1E6PDwUqknWvrFwVRxSEhvDw/Z7yojp2KRwHkTzzU15gZ7xdlIQ/T6YNuaYRXcUAVpFUPgS2VkxvFbXOq0UoxUXdT3uuD+g3e8Yo9fMCt+3tXwo4UQB8xwjXvu9cHQj7l8OnhzV7MaqZG+qvI39/JeDlaMce3imCw1hEQDHhv0FuwPH8DXGVW7hgOSd+ydV7BmT7jAGfZWQxPgFGXa3jsWj9qG0UyIwDhZWWAfImV/DLJCSb9bgRwEq+s+ZiIEW4ItUgRiUw7U9Peff7E7j10tAtkFBZJCnAidRKUG4Wnti81xASb9z68K6A/oSeRT3679bGU1/+87SHEgDHwxVbRbPA8ow573WeEeH51198CQhn1VKBlIMeMuLQRPIo5/hgBmuXXoeD6n258z0PTS87DyB2sziEbXaF8Rzm3wnRL82Csa4U9sl4bFSZdTa0PWXR28fMJzb992cMo+Whx9yp4/aAYBJGYtpOTrZDFLm71o0zxMDrDpLk/WXYoL+3q3jc6mcyy40Se9XWwNmc1y78JKLn6fP9oZsXS3QrnM3y/+AVScCng= +sidebar_class_name: "get api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gives back a list of "What to test" descriptions and the default locale. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/pause-phased-release-ios.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/pause-phased-release-ios.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/pause-phased-release-ios.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/pause-phased-release-ios.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/pause-phased-release-ios.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/pause-phased-release-ios.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/pause-phased-release-ios.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/pause-phased-release-ios.StatusCodes.json new file mode 100644 index 00000000..c2fece58 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/pause-phased-release-ios.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Pause phased release","content":{"application/json":{"examples":{"204 - Pause phased release":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - The release version cannot be found":{"value":{"code":"ERR_APP_STORE_VERSION_NOT_FOUND","message":"The release version is missing from App Store."}},"422 - The release version is not a phased release":{"value":{"code":"ERR_RELEASE_CANNOT_BE_PAUSED","message":"The release version you are trying to pause is not a phased release.","details":{"app_store_version":{"app_store_state":"PENDING_DEVELOPER_RELEASE","release_type":"MANUAL"}}}},"422 - The phased release version is already completed":{"value":{"code":"ERR_PHASED_RELEASE_CANNOT_BE_PAUSED","message":"The release version you are trying to pause is not an in progress phased release.","details":{"app_store_version":{"app_store_state":"PENDING_DEVELOPER_RELEASE","phased_release_state":"COMPLETE"}}}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/pause-phased-release-ios.api.mdx b/docs/release-management-api/store-releases/api-reference/pause-phased-release-ios.api.mdx new file mode 100644 index 00000000..305d9251 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/pause-phased-release-ios.api.mdx @@ -0,0 +1,69 @@ +--- +id: pause-phased-release-ios +title: "Pause an Apple App Store phased release. - iOS only" +description: "Pause a phased release" +sidebar_label: "Pause an Apple App Store phased release. - iOS only" +hide_title: true +hide_table_of_contents: true +api: eJy1V9uO4kYQ/ZWWpWiS0QADu1EktBc5i3cXhQFiLlKyO0INLnBnTNvb3WaGIF7zAfnEfEmq2jY3w0jzsPPgMbb71KlTXcfljROAnimRGBFLp+n0eaqBcZaEXEPAFESAJ86No2GWKmHWTvPLxjHxA+DTX+639zeO4QuN546bJGwMSiOQZhWGPyOgIxuYWAHzcyhcESegOAVsB0XIvo2XP9PuDTBiwhVfgkFEG1PiD3xaBHhLENWEmxDPFXxLhQJEMioFJDoLYcmdJrJcJ7RCGyXkwtkSVwU6QXqg6X7j9jX9OydAKf1ZLA1IQ89zTEzMLP/aX5oWbRx44ktMt4DF9M/i4N0Vj1I62dq/G+f1bb1MYiR5asJYib8heFlwhMPgR+sPgiJSQJJ4vj8Zdd3R8HPPb//ptTDGErTmCzgNvqf56oxWoJZCU8FZAFK8nOsrEqoEcoFw3/Pv2oNBu9edtLxu+4R1GWZP/UyZ853GZGzYPE7li6lTjcsgF6h3e8PJx96oe0x5GALuDB2nagZsxiXBTCFH2rGvN8rsB4bLgKuAIUnA7cx2TfCyLOoNzOIy2IVsBkO323L91qTT/uB1B97E934ftX3vNDuhMR0Jc2EKSI3OUgo3jxUzKAUSlzAz2C7Iu7oXoHFGgLZEYiJgScQNrl++MO8G5Z3Jn1VwlflWqQoXFHD7fVSh53uTsefbHflchY9DoCp2o8oFm6t4uXdISvnmGW64kLiVvPkCR9/reC4W54PbJXK/epO+OxqUilSOs45TxtGwjVoTSROzxHrZhfhVBAzAcBHpXPuJpnQmOd7xRW24se3qdVvt7ifs5LHX6WFrF3yto1vgSe7fd2535Hac3W7I5TlmcagSjxTwYI0biipunnGUzxiw9f2UQjaSJSpe4M7X3122DH9SqFcs+dC763e8oXckYKl/LijU7o7dTrs16Xfc4ceef1fucJBBEgtpKOlYRmuWaj6Nsq4WvUGRrt439M+3t+caGl/0kkdsAAoVYJ5SsXpZVyOuzewc0MX0hp7fxc11mNYgxqkjpII+YmT2qGI7PeTs6V5MY0sSa2OnFJxCmk4N2VXy0unaRgRbuhJBha7bGtZyJWp2j9iJighmw02qIgTZTPH+yO9si2crSy6R1BJ51FaNmsWpFIrWVnVEWXElSHArQb4+k3fO0wiFc0JjEt2sIR9RnQochnDzidhuv8MK0AbPKDGCYYjDHoUJrTfboco6FE1RxSw4sFdt5Hwi3A1dGOw3WBejWoj9CKoUsu8OGVo+Ka/W1D7UPG6/jTYcYVvcFDNfMY/Y2luXFHIe22jCRHDwOr/b6WVx7BS6G0pJraK5nFWjWi8Rur7uxPGDteb8pRRHASG9v75mf2C34/uBzYUMGL7TQlDQZG84CxXM316dqxmqUAnima7hEniqhmYZvcdS62qixBJz7mJ+b3PuPzRu9+zxB0bF47iOhxZCXDHD1QLM26vJNOLy4erduG5z1AnM3tT4u6/yqxzuGWPtooheZAEkCrBt0HrQsj7CVKWkdl0b1rht/FJFzR6wwCn5WMiNNbWQrwDfUgtll2FhSAoJjxZ4CvPYPgyySkGfVSADQXUri1QEYCU4k4pAbIqBOf33z79s3GB3xUL2iRZShg4WnroO4an2+eawg7Ymsz394jgxXNwNZEhkUqeF3+x95vIXUL6zDTyZGvombmzkYxt3k7vAF+fQBXBJ036tnBjB/g1n7SPNvolCshNE2GQmoKLtli5/S0HRN9f9vtOtYQTC2iwa0ZxHGp7J50c/H+d+YpeSKHpWrq2hWJ908PQBO9h+cW3v8am8iSl6dsOdzSAxB0tKDk1msTPMfm8wJDVSkurQKB6sUeQn9vPyHJ9jEyjI0XF7c2HJZpPZEEpZPJ/durhiZ1R56pQCet7/VbEp/w== +sidebar_class_name: "post api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Pause a phased release + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/pause-staged-rollout-schedule-android.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/pause-staged-rollout-schedule-android.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/pause-staged-rollout-schedule-android.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/pause-staged-rollout-schedule-android.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/pause-staged-rollout-schedule-android.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/pause-staged-rollout-schedule-android.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/pause-staged-rollout-schedule-android.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/pause-staged-rollout-schedule-android.StatusCodes.json new file mode 100644 index 00000000..8fe9d264 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/pause-staged-rollout-schedule-android.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Pause staged rollout schedule","content":{"application/json":{"examples":{"204 - Pause staged rollout schedule":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Schedule not found for this release":{"value":{"code":"ERR_SCHEDULE_NOT_STARTED","message":"Cannot pause the staged rollout schedule: it has not started yet."}},"412 - Already released":{"value":{"code":"ERR_SCHEDULE_ALREADY_FINISHED","message":"Cannot pause the staged rollout schedule: already finished."}},"412 - No schedule exists for this release":{"value":{"code":"ERR_NOT_SCHEDULED","message":"No schedule exists for this release."}},"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for Android releases."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/pause-staged-rollout-schedule-android.api.mdx b/docs/release-management-api/store-releases/api-reference/pause-staged-rollout-schedule-android.api.mdx new file mode 100644 index 00000000..3afb6c8d --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/pause-staged-rollout-schedule-android.api.mdx @@ -0,0 +1,69 @@ +--- +id: pause-staged-rollout-schedule-android +title: "Pause staged rollout schedule - Android only" +description: "Pause staged rollout schedule for the given app version." +sidebar_label: "Pause staged rollout schedule - Android only" +hide_title: true +hide_table_of_contents: true +api: eJylV+1u4kYUfZWRpSptFHBgt6qE9kPWQnZRCaEGIm13IzTgC57GzHhnxiQU8bcP0Efsk/TesQ0hQLS0+UEM9j333K9zxysvAjPRIrVCSa/h9XhmgBnLZxAxrZJEZZaZSQxRlgCbKs1sDGwmFiAZT1O2AG3QsupdeAYmmRZ26TW+rDyr7gHxvtyt7y48RDN47QVocJsbGFZhH5WaIWgv4UvWt0oDCyEBbsBDG5WC5kSqHZW0+o5VmJPqF5wCGWklIvSfcs3nYBHfMZD4BS3dLUGhpdzGeK3hWyY0IKrVGSBtBJpzr4GclylZGKuFnHlrYq7BpEgWDN2vX76mfyckDN1NlLQgLRlivhIxcUH5fxiyXnnwyOdpssHHrLwMiI8teJLRxdr9XXivL2v7tIaSZzZWWvwJ0WksEA5Z7Ng/cYpIESWpFYajYTcYDj7dhO3fW030MQdjkPRz51uarw5kD/RcGGoIFoEUp3N9RRnbAzlCuNcKr9v9fvumO2q2uu1nrPdhttQPFL7oVSaVxbnI5MnUqdj7IEeod28Go6ubYXeX8gBnEVtUZXoCbMIlwYyhQNqwr9X32eMsyYjriCFJwAZnm7E4LYpaHaMoZ3EbRqEUwiBuPtJH4up/+NRqDjstF2B/EISDZ1X5kEeVuqkg7TkyGQ0mLIu5cRzwGW3xoSXYqlfkAHkGiQYeLUtOR5O9IRV0wlbQ/Dy6anfb/U//mRkv/E6FFAZ/fMqpq7byCo/CWPPduXMpK6juUvsO0KccjjfDsQQNgm4zCJujTvtDq9tvjcLWb8N22HrenehuDBKmWJoC0jC+765cK9h4EiZUOOy76raB6wcauC2RmIhYmnCL9vMT+7ZOce9hHAm33b0NOu3mqNcJBlc34fV+lCCjVAlpGV4rmSxZZvi4WJjFhioTb7aB/Xx5eSgwXGGSJ6wPGrcra2mt9GnRIa6L7hDQ0RAHrbAbdHZC6yvcpzEuQ/aAntmDVm4vFuzpnqLlnCpj3f7F/drwfGRXKY4Fxl+JaO3P3KKvYJqXFUOL3s9HpVKMSqVsVt8NkztLEOV8kWc6QdjVGHM3DDtrv8hjZc4lgsyRmb+o+w63UubYX9QQZcG1oDK4pBT2ecKnPEswlV5sbWoaPnIW1bHAxY+DIRSa7taEdDanxAiGIQ57EDbOx54OEG6e6MRQnoL67lfnuTgLbQ4Y6OxXWJbHkhilAfSey14wYDgMVAu9ZFYxUpmg10aZTxKDjxfnm3LTum5wMy3kVDlvwtKBYbOorjf5cjgoh0+OY5St/BItFvVqbY/Q+XlHqXtqhnJcVRIR0vvzc/ZZZbR/SOEiJ8SgUffecBZrmL49O1QzzEIlUhPjowk8VmM7T95jqU011WKOMXcxvrcF9x/ql1v2+AW94udtDT+aCHHGUO9nYN+ejcYJl/dn725rLkaTwuSNz999lV/lYMsYa5cktCgjSDXgIKHi4Na/grHOKNs1Y1n9sv5LFXN2jwXONAk8t2yJYcZ8AWwuZtqZYWEoFRIeHPAYpso9DLJKTl/MQA6C2a3MMhGBS8GBUARikw+M6Z+//ma3dXZdGrKPZEgRelh4mkOEp9oXzfHyab6ykSaSrOcFX20V5/+8FRQ9b+HR+igA2PLI1I30qlCML95TxUCThjuz74kGycJh2XDik+XvDTGJEWKucsHQyXpNP3/LQNObyd1WFZy4RMIJNcrYlCcGXsjBj2GxFH9ix8Iq51sunfg4lfXw8h6n3b2JrO/wqWLgyXt+I5hMILVPTPb0nYRlI7e9m/4AH6bB3xWVeycqxYV7CTvEZ1cwSnL0ub44YrJa5ZKFqSyfz28dtdiIWhE6hYD6+C8J9/L/ +sidebar_class_name: "post api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Pause staged rollout schedule for the given app version. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/release-management-api-app-versions.info.mdx b/docs/release-management-api/store-releases/api-reference/release-management-api-app-versions.info.mdx new file mode 100644 index 00000000..e037d028 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/release-management-api-app-versions.info.mdx @@ -0,0 +1,81 @@ +--- +id: release-management-api-app-versions +title: "Release Management API - App Versions" +description: "**Looking for the old API?** You can find it here: V1 API spec" +sidebar_label: Introduction +sidebar_position: 0 +hide_title: true +custom_edit_url: null +displayed_sidebar: releaseManagementSidebar +--- + +import ApiLogo from "@theme/ApiLogo"; +import Heading from "@theme/Heading"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; +import Export from "@theme/ApiExplorer/Export"; + + + + + + + + + +**Looking for the old API?** You can find it here: V1 API spec + +The old API will be deprecated on February 1st 2027. Make sure that you have migrated to the new API before then. + +View the V1 → V2 Migration Guide + +
+ + + + + + PAT necessary to use API calls + +
+ + + + + + + + +
+ Security Scheme Type: + + apiKey +
+ Header parameter name: + + authorization +
+
+ + +
+ \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/remove-what-to-test-description.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/remove-what-to-test-description.ParamsDetails.json new file mode 100644 index 00000000..5462887f --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/remove-what-to-test-description.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"what_to_test_id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/remove-what-to-test-description.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/remove-what-to-test-description.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/remove-what-to-test-description.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/remove-what-to-test-description.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/remove-what-to-test-description.StatusCodes.json new file mode 100644 index 00000000..0fbc4255 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/remove-what-to-test-description.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Remove description","content":{"application/json":{"examples":{"200 - Remove description":{"value":{}}}}}},"400":{"description":"No release candidate","content":{"application/json":{"examples":{"400 - No release candidate":{"value":{"code":"ERR_BAD_REQUEST","message":"There is no release candidate chosen"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - App Store Connect API credentials":{"value":{"code":"ERR_UNAUTHORIZED","message":"The specified connected app does not have a valid App Store Connect API credential"}},"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/remove-what-to-test-description.api.mdx b/docs/release-management-api/store-releases/api-reference/remove-what-to-test-description.api.mdx new file mode 100644 index 00000000..af4b00fd --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/remove-what-to-test-description.api.mdx @@ -0,0 +1,69 @@ +--- +id: remove-what-to-test-description +title: "Remove the 'What to test' description with the given locale - IOS only" +description: "Remove the 'What to test' description with the given locale." +sidebar_label: "Remove the 'What to test' description with the given locale - IOS only" +hide_title: true +hide_table_of_contents: true +api: eJy9V+1uIjcUfRVrpCptFJjAZlUJ7YfYhW3REpICSdVuImRmLoybwZ61PWQp4m8foI/YJ+m9nuFzhq3QSs0PYhjf43Ou7XPvLL0QTKBFYoWSXsPrw0zNgdkI2IP3a8Qts4pZMPbBYzsz2bOwkZs1FXOQLFYBj6HqXXgGglQLu/Aan5aeVU+AqJ8eV48XnuVTg2OvmSTsHrRBGMMqbGCVBvYOLGctYawW49RxwQiVgOb0pRNuqBGnoRoio9YO8Qsv4ZrPwCKuW1niF4wRIT4SJCzhNsKxhs+p0IB4VqeAdIMIZtxrINdFQhHEQE691epiA/KMS46sGlEaRt+A+EiTTYKywdDz+uUl/SvdgHBPXKCkBWlpNk+SWAQuK/4fhkKWHnzhsyTegGJSS1Dw2ZzHKTJartzfhXdVRqCnmIYYuAEWcBmKkFs4jcKVo1CKs0MCEUNKT7vfH71rtkb99i937cEQl5qBMXxKz4YR4NkQhskSMBZEyuDx2qqpFdXcSZ7aSGnxJ4SnqqihCjqs2Ql9r6SEwLLmbYcFuN8II3hsjkm66zXvhj/f9Du/t1uHmphJIBATASELMlQcIR8WKiCtlkUcd48zBBbhf3LwcvVId0/uqcz2grdZfVHM6i3omTB0g/GISXF6al8g1yLIEcK37f51ZzDo3PRGrXavc8C6CLOlflV2v7JjRFmeqFSeTP3KXa9DkCPUezfD0Yebu17xCKATqFQH7jwTzBhypA37Wr3IfmDx9HMdMiQJ6CNs4z6nqajVnfMeAzuiZjBs9lrNfmvU7bxv9wZtd2c7/cIBxws7BgkTYdeQBg9zYbmJ0q6E7N2B6jYB9ZIEdGR2J5KYW4yfnai7TroLGEfkdnr3zW6nNbrtNocfbvrXRZUgw0QJacmilIwXLDV8HGfKxM1g7VlmK+plmeV2UICWPGYD0HPQrK210qcpe+k8txzoqLxhu99rdvdkDRQW0QjrFXvGldmzVq505ezpmaJaHKIwVxZcEWx4PvKrzPOi7i9FuPLHWNEr4U5F96mOVqyqUB31lwdVdeV6B2KdFfBUx4i7HGP67vrdlZ+nsjLjEpnOkJw/r/uGbLGyTrM/ryHKnGtBu+DyksdnOZ/wNMZsepG1iWn4SFpUxwIJGqgKhaH72+KcOkskwTDE2fY9rsyD29jHbdczcL+6lfPeZ9MG4GIfYbFuHiLgIejCkrfNIcO7QNuhF9R6pbiuc3seY625WLcka6N2B8L5v5AT5VYTNoYdn7ve5MvhZBVt3X5RtrIhRszr1VqB0Pl5V6knOg/r26rikJDenp+z31RK9sUmQoYMLztV6wZ7xVmkYfL6rGzPMAuVUAXGxxD4Uo3sLH6LW22qiRYz1NxDfa9z7t/VL7fs8Quuip/3NfxoIcQZs1xPwb4+G41jLp/O3tzXnEaqrq98/uZBPsjhljHuXRyTz4aQaMC7hIaDReMDjHVK2a4Zy+qX9R+rmLMn3OBUUx+MHfACZbqCPBNT7cKoJ0ZgCc8OeAwT5SaDrNKiX81ABoLZrUxTEYJLQYkUgdi0Bmr656+/2X2dXa8D2U8USAo93PhEGYvwtPf54fimHp5cBJ2L3OzwMCy3hvTt7wn5rbDwxfpoxHgpUIu79MvcVD55u6aCIQ3Xexd8BX/bdRaaeNix4w3FXtES5jKzFB2vVvTz5xQ0vas8bn3D2Q8uQGP0ugk2efCVTHzfz6vmD+yYrLUDyIWzJ2fFHg6f0A/cOwq9bPyPKx6mZ/WIIbkjkfhsVjMIILE78YUaRM63KQmtdrc9bON08qZ933tyvpcP3HthGb19T1tzpU9KT2nIcpm56mq1mZ89Ohqx8d089yQCLfxf0pImIw== +sidebar_class_name: "delete api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Remove the "What to test" description with the given locale. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/resume-staged-rollout-schedule-android.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/resume-staged-rollout-schedule-android.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/resume-staged-rollout-schedule-android.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/resume-staged-rollout-schedule-android.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/resume-staged-rollout-schedule-android.RequestSchema.json new file mode 100644 index 00000000..493db0fe --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/resume-staged-rollout-schedule-android.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"location":{"type":"string","description":"The time zone in which the schedule dates are provided. It can be any TZ database time zone or UTC if the dates are given in Coordinated Universal Time."},"schedule":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the existing schedule item, returned by the corresponding GET endpoint."},"percentage":{"type":"number","description":"A number greater than 0 and less than or equal to 100 representing the release percentage, where 100 indicates a full release."},"when":{"type":"string","description":"A date in ISO 8601 string format specifying when to run the schedule."}},"required":["id","percentage","when"]}}},"required":["location","schedule"]}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/resume-staged-rollout-schedule-android.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/resume-staged-rollout-schedule-android.StatusCodes.json new file mode 100644 index 00000000..2590c556 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/resume-staged-rollout-schedule-android.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Resume staged rollout schedule","content":{"application/json":{"examples":{"204 - Resume staged rollout schedule":{"value":{}}}}}},"400":{"description":"Percentage out of range","content":{"application/json":{"examples":{"400 - Invalid time format":{"value":{"code":"ERR_INVALID_TIME_FORMAT","message":"when must be a valid datetime string; given value: 'gibberish'"}},"400 - Percentage out of range":{"value":{"code":"ERR_VALIDATION","message":"Validation failed: Percentage must be within the valid range of 0.01-100","details":{"percentage":["must be within the valid range of 0.01-100"]}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Schedule not paused":{"value":{"code":"ERR_SCHEDULE_NOT_PAUSED","message":"Cannot resume the staged rollout schedule: it has not been paused."}},"412 - No schedule exists for this release":{"value":{"code":"ERR_NOT_SCHEDULED","message":"No schedule exists for this release."}},"412 - Schedule already finished":{"value":{"code":"ERR_SCHEDULE_ALREADY_FINISHED","message":"Cannot resume the staged rollout schedule: already finished."}},"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for Android releases."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/resume-staged-rollout-schedule-android.api.mdx b/docs/release-management-api/store-releases/api-reference/resume-staged-rollout-schedule-android.api.mdx new file mode 100644 index 00000000..bb7593fb --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/resume-staged-rollout-schedule-android.api.mdx @@ -0,0 +1,69 @@ +--- +id: resume-staged-rollout-schedule-android +title: "Resume staged rollout schedule - Android only" +description: "Resume a paused staged rollout schedule for the given app version." +sidebar_label: "Resume staged rollout schedule - Android only" +hide_title: true +hide_table_of_contents: true +api: eJytWOtu47gZfRVCQJF24PvutoW7sws18cwYTZzUlwC72SCgLdrmRia1FOWM1/DfPkAfsU/S85GS5WtmUjQ/HNkSz3e+2+FHrYNIpBMjEyu1CtpBX6TZQjDOEp6lImKp5TP8MzqOdWZZOpmLKIsFm2rD7FywmVwKxXiSsKUwKTBqQSVIxSQz0q6C9sM6sPpZAPnhcfNYCYCW4joIseDeL0hZlX3UegbQu5iv2MBqI1hfxIKnIsAanQjDiV432hIcOFp9z2qQkwpVZLSMQCDhhi+EhQFHQeELlrpbkrxMuJ3j2ojfMmkEYK3JBHgDaMGDNkivElqRWiPVLNgQdSPSBGxFSvdbjW/p38nYnQkZ7E20skJZWomIxXLi3Kr/mtLydSA+80USbw0gLl9AxHNLHmd0sXF/leDbRuOY2J0wE9gFCKP1esoMV7M3MgIyGHUVLMqIWblwRbDgdpcGACMKXKfff+r27sPr7tXTsHvTefpw278Jh7C4EGkKInjmZY7KWWSpZWMqOI8bcSsctg/93/ICc/htdjGT47EwMp1fBLm34HTOvTO8HKtw2L3t7dG5J/vOfTblMhZRexe44Pki7VwqV/qesDNFNhu1RrPaRPgriL4FgotasoWgsn8DyuOmTGnzOKUjxTM710b+LqK35rGJmO2tPxOoUS8cDT/d9rs/d672QrW3uKT5zcnKW8iU2pxFQsm3c/3G5/cA5Azhu07/pjsYILNPV51e94D1MUxJ/WQ3OwViSlsUeqbeTN038CHIGeq92yF6ZNTbpzxEgUB3dIYiYhOuCGYscqQt+2brmD0EUkXcRAwkBVSLbbXubV40W/CiEFjnht8YzvkxuPzUuRpdd5xDd+FocJCES++E8cJGDXBG3NpMWjbnKfM+QwO84VqQ+wxePV1uSOKzTG2a70syhQW/gbwS74LrPsOvAN3lsI0Nj43g0YpNpYI+fUWEwut+J7z66elDt9cdfPrf43RoeI/d2TI4x24Y9q7C/tXTdfey0xt0nvqdf466/c5hXSIYY6HEVNoCMoWGH5krxgSUnBITC/6ouFpZuq0TpVtsMUnMLe0wb6zYVmtnm9pifGGPursOh7RFHXspVJRoqSzDtVbximUpH+cDUD5wFGWRlo59d2ob7sIJo3jMBsJgWmIdY7R5m3ff5ZvwKaCzLg47/V54vefaQGM8whY0Yy+wzF6MdmNOzp4yKlL7dx2tPNir/I6mJj3+FbmmMczQ7Gal5x5rv/B4vqocBIpkzw0Bv2slGDbKl7mczH0XFO1GgwJKDqMirCxlhLpnXUsi6cYJtWLDn+khPib9LdGQttHwksmpgytR/JwBW5dam0gqTsU6UpLGWkR6CACk18+IxfCVe8GN4SsaLa1YpF+Og4y+LgIoLO1ZOhmiZG29J1MV1J3NjALP8SrvMuOn1Ige/tgZbqvXUd+dRbYEVLbARHVEIGT+BptBXFBtwEdkGwgsmhtl5L8jmCgVhMdqhqEFhBIQgA2yb93m5fe/0nQFyRSINz0uQXTiM8CmWRzv6GvFjYdfDlToUkh56w5u2V//jOHGP5kPpyxNxEROV67UaeAEU5OpvVryglkq44M/KeyEK2fzuDl8cFvTO4Xx6JuIGkzTiSXRqSsCOnO0gzpaqJqfldL6Wkab+sydfqrQqlU1pdNP3Wt9Ndf6agFd99uBO2FR4/vTTWZi4K6pzkf96009D2J1wRVQFnChvmzVHXC1UKr6sgmUJTeSxMyVZb7ey9aUZzEaPphbm6TtOkjL2lgisEiO1CfL1VNirt2A42bcbZhd87hjVHE2HLhffbv4E2LZT4n8h1gVZ7U5NrcTBXoXDhm2FFI0s6KsYjhg4V0XChBj9K4Uh75iUvVposSQbvVLhet4ed1XqLLcyn5/8K1b3trtp0ZRsNsz4+OGHJhq55i0hLCdKW+2qXGUq2z3PEyJ8ZdYsWzVmke+v3t3rfVzXuQuxjqOCOnHd+/YTzpzKohxIHIzFLqtzb7nbG7E9P3FqfJAwKuRnqR1LBGfa3O7iH9EVaW1xMgFwttDKN/n3P/QapTs8QVW8XnfxMcVIC6Y5WYm7PuLp3HM1fPFD/dN5yP14fd1/sMv6hc1LBmjTND3UOyIpGPiVBcD+gcxNhkltokDU6vR+ksNMXtGLWWGpiH09QpuzvkSJzM5M24ZaoBCocSLAx6LqXYPC1Ujo69GwIMgutVZhr3EheCEKxLYZAM+/edf/2b3LXZTLGQfaSF56KQWPQ94yn1eh68f5akE8mGChozDjO/swf+fNzR5p1nx2dahO2g0kHZCss6F6iHYFSosaTtRPNIqapHTauVesDi9QtvPSQQBuvY6ZeLNhn5GFxp6TfRYipFrtEi6KQvtNuVxKl4Jxx/7uRz/iZ3zq5AVtXKa50akAJfPEBn3Vsj1aq4zZN3fuPQ2qkNaXi48GoE2lWJFOJmIxL767OPOxnB3O6A3IuN8zFr4mc3wF4ocPh1J7Xx2Oul+g0pxNcv8GOcxSdRI5vYl9NlJaH7hXsSdCsO+PBYxoU9y6+SS9doLNDJYPO9vnV2xlfA84hQHsP4vVhwIrA== +sidebar_class_name: "post api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Resume a paused staged rollout schedule for the given app version. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/sidebar.ts b/docs/release-management-api/store-releases/api-reference/sidebar.ts new file mode 100644 index 00000000..366843cb --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/sidebar.ts @@ -0,0 +1,294 @@ +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; + +const sidebar: SidebarsConfig = { + apisidebar: [ + { + type: "doc", + id: "release-management-api/store-releases/api-reference/release-management-api-app-versions", + }, + { + type: "category", + label: "App Versions", + items: [ + { + type: "doc", + id: "release-management-api/store-releases/api-reference/list-releases", + label: "Get a list of app versions", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/create-release", + label: "Create an app version", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/delete-release", + label: "Delete an app version", + className: "api-method delete", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/get-release", + label: "Get an app version", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/update-release", + label: "Update an app version", + className: "api-method patch", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/list-outgoing-webhooks", + label: "Get a list of outgoing webhooks", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/create-outgoing-webhook", + label: "Create an outgoing webhook", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "App Versions - Release Candidate", + items: [ + { + type: "doc", + id: "release-management-api/store-releases/api-reference/get-release-candidate", + label: "Get data on the release candidate", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/submit-release-candidate-for-beta-review", + label: "Submit release candidate for beta review", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/upload-release-candidate", + label: "Upload a release candidate", + className: "api-method put", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/get-release-candidate-upload-status", + label: "Get the upload status of a release candidate", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "App Versions - Approvals", + items: [ + { + type: "doc", + id: "release-management-api/store-releases/api-reference/list-approval-tasks", + label: "Get a list of approval tasks", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/create-approval-task", + label: "Create an approval task", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/delete-approval-task", + label: "Delete an approval task", + className: "api-method delete", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/get-approval-task", + label: "Get an approval task", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/update-approval-task", + label: "Update an approval task", + className: "api-method patch", + }, + ], + }, + { + type: "category", + label: "App Versions - Store Beta Distribution", + items: [ + { + type: "doc", + id: "release-management-api/store-releases/api-reference/list-testing-groups", + label: "Get a list of testing groups/tracks", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/finish-beta-distribution-on-testing-group", + label: "Stop beta distribution on the testing group - IOS only", + className: "api-method delete", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/start-beta-distribution-on-testing-group", + label: "Start beta distribution on the testing group/track", + className: "api-method patch", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/list-what-to-test-descriptions", + label: "Get a list of 'What to test' descriptions - IOS only", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/create-what-to-test-description", + label: "Create the 'What to test' description - IOS only", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/remove-what-to-test-description", + label: "Remove the 'What to test' description with the given locale - IOS only", + className: "api-method delete", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/update-what-to-test-description", + label: "Update the selected 'What to test' description - IOS only", + className: "api-method patch", + }, + ], + }, + { + type: "category", + label: "App Versions - Apple App Store review", + items: [ + { + type: "doc", + id: "release-management-api/store-releases/api-reference/cancel-review", + label: "Cancel App Store review", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/get-review-status", + label: "Get App Store review status", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/submit-release-candidate-for-review", + label: "Submit release candidate for App Store review", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "App Versions - Apple App Store Release", + items: [ + { + type: "doc", + id: "release-management-api/store-releases/api-reference/create-store-release-ios", + label: "Release App Store app. - iOS only", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/complete-phased-release-ios", + label: "Complete an in-progress Apple App Store phased release, releasing to 100% of users. - iOS only", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/continue-phased-release-ios", + label: "Continue a previously paused Apple App Store phased release. - iOS only", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/pause-phased-release-ios", + label: "Pause an Apple App Store phased release. - iOS only", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/get-release-settings", + label: "Get the release settings for the app version", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/update-release-settings", + label: "Update the release settings for the app version", + className: "api-method patch", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/get-release-status", + label: "Get the release status of the app version", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "App Versions - Google Play Store Release", + items: [ + { + type: "doc", + id: "release-management-api/store-releases/api-reference/update-localized-release-notes-android", + label: "Update release notes for different locales - Android only", + className: "api-method put", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/create-store-release-android", + label: "Release app for all users or for a fraction of users. - Android only", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/delete-staged-rollout-schedule-android", + label: "Delete staged rollout schedule - Android only", + className: "api-method delete", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/get-staged-rollout-schedule-android", + label: "Get staged rollout schedule - Android only", + className: "api-method get", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/create-staged-rollout-schedule-android", + label: "Create staged rollout schedule - Android only", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/pause-staged-rollout-schedule-android", + label: "Pause staged rollout schedule - Android only", + className: "api-method post", + }, + { + type: "doc", + id: "release-management-api/store-releases/api-reference/resume-staged-rollout-schedule-android", + label: "Resume staged rollout schedule - Android only", + className: "api-method post", + }, + ], + }, + ], +}; + +export default sidebar.apisidebar; diff --git a/docs/release-management-api/store-releases/api-reference/start-beta-distribution-on-testing-group.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/start-beta-distribution-on-testing-group.ParamsDetails.json new file mode 100644 index 00000000..fcb02094 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/start-beta-distribution-on-testing-group.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/start-beta-distribution-on-testing-group.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/start-beta-distribution-on-testing-group.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/start-beta-distribution-on-testing-group.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/start-beta-distribution-on-testing-group.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/start-beta-distribution-on-testing-group.StatusCodes.json new file mode 100644 index 00000000..a7cfa483 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/start-beta-distribution-on-testing-group.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Start testing (ios)","content":{"application/json":{"examples":{"204 - Start testing (android)":{"value":{}},"204 - Start testing (ios)":{"value":{}}}}}},"400":{"description":"Bad request","content":{"application/json":{"examples":{"400 - Bad request":{"value":{"code":"ERR_BAD_REQUEST","message":"There is no release candidate chosen"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Invalid Google Play API credentials":{"value":{"code":"ERR_INVALID_CREDENTIALS","message":"The specified app does not have a valid Google Play Store API credential"}},"401 - App Store Connect API credentials":{"value":{"code":"ERR_UNAUTHORIZED","message":"The specified connected app does not have a valid App Store Connect API credential"}},"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Do not allow testing on production":{"value":{"code":"ERR_PERMISSION_DENIED","message":"You cannot publish an app version to production for testing."}},"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/start-beta-distribution-on-testing-group.api.mdx b/docs/release-management-api/store-releases/api-reference/start-beta-distribution-on-testing-group.api.mdx new file mode 100644 index 00000000..ef279d89 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/start-beta-distribution-on-testing-group.api.mdx @@ -0,0 +1,69 @@ +--- +id: start-beta-distribution-on-testing-group +title: "Start beta distribution on the testing group/track" +description: "Initiate the beta distribution testing of the release candidate on the given group/track." +sidebar_label: "Start beta distribution on the testing group/track" +hide_title: true +hide_table_of_contents: true +api: eJy9V+tuGkcUfpXRSpUTy7CGJKqE4kTEkGRVB7uALbWJhYbdAztlmdnMzOJQxN8+QB+xT9JzZpebF9zSqvUPvLDn8p3bN2cWXgQm1CK1Qkmv4QVSWMEtMBsDG4LlLBLGajHMSIBZMFbIMVMjJ6AhAW6AhVxGIiI1ksEXYzEDycZaZalvNQ8nVe/MMxBmWti51/i88KyaADr8fL+8P/MsHxt89pppyu5AG3RlWIX1rNLA3hGK1hYKDzVUCprTlyBC1D3LtSW5bbFr2c/RfiAY6D/lmk/Bon2HQOIX1BURvhIUe8ptjM8avmZCA9q1OgOEHcYw5V4DMc9T0iAXcuwtl2drIy7Swb8wdU/CJsW4wdD7+vlL+rdbHBfmugbPhDLP0UmopAVpSZynaSJClxf/F0M6Cw++8WmarK26tO6YwdppJaLnJDDjSYa4FhjbfmHnc0eQ/s68l+fnZbzveMQoBah8HE60hq631bdcoqGIctfudgfvmq1Bt/3jbbvXRw9TMIaP6V0/BuwcYZhUe5o0jJXB5ttgr5Wx30qe2Vhp8StEx4KvIfhAIl4RsQ9KjRNgNwmfs+ZNwEJsBzQkeGIOBRV07ppXQWtw2W232p1+0LzqPQ6OmRRCMRIQMYTDIgUUqmUxnwHjrOw6H6VdAF4RPKKlwctFLpWUENq/i/W207ztf7zuBj+3W0+ADHOrT8L9KwxbcHeKcyyyHeVND7wo98AN6KkwxEYMMYjjG+EFYm0pFypPEvWw4U/JUq2iLMw97Y/gpt39FPR6wXVngH0QPArjJ5VRS5PtNBsmwsSMS5feWc6gzKotJ2yk9Mp9tUglwSvH+I/QlM1sMruHybrFTBL6kcrk0ZklaiobOQC9c90fvL++7ZQ7FDlXZTqEVSaHUFhao6/V9/KwjLiOGIIEZGy25vnjoqjVc4I9YOxANL1+s9NqdluDq+Cy3em1HQEG3dL8IfsNQcJI2JVJg7NWcuf6AlOxM6LVdQJe7SP2AGPUkiesBxq7jbW1Vvq44F85it9v6CAv9tvdTvNqJ86ewiM9ppl6QM/sQSt3nhbo6Z2K8gM5jN0OgAdzw/MRXqWYE+MvRLT0admpbC87fjEtFXe4o9TqkF+6XYbw5otEphM0uRhiL952r5Z+ceBUplwixinC8md13xC1VYp3xp/V0MqMa8GHRUYK/TzbI54lmEcvtjY1DR/xiupQIDYDVaFQdbcgjm3zFJIZhnbYg7Cxq6zbOsCV9H6zhfXcr85zsYuttxJ09gPMV7tMDDwCXXJ50+wzbBgqhJ4T12SmOGCQ6gyKF6vRimxdKzjiEXKknDdhE9gig0/rfDk7+am0WgcpW/kjaszq1VoJ0OnplVIT6oRVS6skIktvT09ZwZZsJGTEcCJoP2iw15zFGkYXJ/tqhlmoRCo0PqrAt2psp8lbLLWpplpMMeYOxndRYP+ufr5Bj1/QK37e1fCjhSZOGG5RY7AXJ4NhwuXk5M1dzcVIJ+Rrn7/5Ir/I/gYx1i5JiIwiSDXgFOFUIrO+h6HOKNs1Y1n9vP59FXM2wQJnmhZ2btkcw3SH6lSMtVPDwlAqJDw4w0MYKScMskpOn8xAbgSzWxlnIgKXgj2hCLRNPjCmP377nd3V2aeVIvtAihShh4VPlbFonmpfNEe+XZbvGcU1YnVcbl0kHpd9sSGd//TyUoyGhW/WTxOOk4EBuclfFKTy2dsmFVRpuPtAiVfI2A6zkOj6AoETitupJXOLnFJ0slzSz7gIa7o73W94w9EP2qZnZLkRLmrwRH6edYuj5Tk7FNGKAeTc0ZMjYQ8fJ8gH7q5El57/0eM6L8t7lC2oiKLOXzfDEFK7pVg6dojy1qcActblR5QmTtrlu4nju+LB3U/3wdrlshVG+qS07FVZLHI2XS7X8vmrgxprvi1yTjEgdf8JxaxdGA== +sidebar_class_name: "patch api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Initiate the beta distribution testing of the release candidate on the given group/track. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-beta-review.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-beta-review.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-beta-review.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-beta-review.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-beta-review.RequestSchema.json new file mode 100644 index 00000000..796e9ea3 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-beta-review.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-beta-review.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-beta-review.StatusCodes.json new file mode 100644 index 00000000..e78620bb --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-beta-review.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Submits the release candidate for beta review","content":{"application/json":{"examples":{"204 - Submits the release candidate for beta review":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Unprocessable entity":{"value":{"code":"ERR_RELEASE_CANDIDATE_MISSING","message":"There is no release candidate chosen for the app version.","details":"You can set a release candidate using the API by updating the app version with branch and workflow information.\nMake sure that the latest build there contains an installable artifact.\n\nYou can check how to do this here: api/release-management/api-docs#/Releases/UpdateRelease.\n\nAlternatively, you can also do this on the UI. Check the documentation out: https://docs.bitrise.io/en/release-management/releases/managing-the-release-process/selecting-a-release-candidate.html.\n"}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-beta-review.api.mdx b/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-beta-review.api.mdx new file mode 100644 index 00000000..a69fcf01 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-beta-review.api.mdx @@ -0,0 +1,69 @@ +--- +id: submit-release-candidate-for-beta-review +title: "Submit release candidate for beta review" +description: "Submits the chosen release candidate for beta review. - IOS only" +sidebar_label: "Submit release candidate for beta review" +hide_title: true +hide_table_of_contents: true +api: eJytV+1u4kYUfZWRqyptFHBgt6qE9kNsQraoCUkNRGp3IzTYQzyL8bgzY7IU8bcP0Efsk/TcsQ0kQNpIzQ/ij7nnnvt1Zrz0ImFCLTMrVeq1vH4+nklrmI0FC2NlRMq0SAQ3uOVpJCNuBZsozcbCcryaS/FQZzXWve4zlSYL78RTmdCc4LrRGjAoMM4qiAulPwAgcPawMSLMtbQLr/Vp6Vk1FeDy6W51d+JZfm9w7bWzjN0KbYBr4K8EZGtED2szrvlMWKxyOCluwEBGcCApuIzbGNda/J5LLcDO6lzAeRiLGfda8LzIyMJYLdN7b0X+tTAZXApD75unr+nf4ZT9a67gPlSpFaklIJ5liQxdsvwvhtCWnvjKZ1my9odYX+YAZnOe5IhjuXJ/J97r08Yu7WHKcxsrLf8Q0ctYAQ6sHtlvOQVSREnsBMFo2GsPBz9dB93fOufwMRPG8Hvx1PmG5qtdmjdCz6ShsrNIpPLlXF+B6y7IAcI3neCq2+93r3uj806v+4T1LsyG+p7GqHo0VRZVytMXU3+91egbkAPUe9eD0cX1sPeY8sD1jFG5Dl3TEMxYlEhr9o3mnra2aDGuIwaSAgPA1mPzsigaTWrhg2AHoukP2r3zdnA+uuyedXr9zijo/DLsBp2n0UmDcFIxkbaCNIzvuqMhcZKm0lSEVkQMvOubBDT3JKCbgpiMWJZwC/vZC+NuNt2QZFqFxHecCAZTp3H7Qw46l502Ij1D5N3z9qAzcq3Y+/i0oFowhJ2qPWJQSnYVLkiyeSGadaBEkAmZgJ73q8rJihlhGd+DkxsIoINo33TZeMHyDM+rZ1uw7EHamI01T8OYwZw9KD2dJOqByZSS5hJU/5xe8algJgd1G3PrUJBWYdCNuUwieqBdecAQAg9q+Gd5krjEcW3lhIcWQJ/TijtUO5yyGK6sYpECBLJCMC0QlH4ZVG3GU2Ruhtz7eFyLVGi+8cupMv6Q4hLlrYNvJ9hAUvCei2RxwhalN56YjRfETREMu3V25ljQHZBzcuNCZiq3LRZbm5mW75PT+lhiW4ETqXyR7qOnK1LuGZJdA2ytWlg2km9wH1Ipanz9bl24emxnCcLwyq6mnflpGx9ov27vtn3ZPR/dXLYHF9fB1e6giTTKlEwtcxlI0BRFW1O3Sez/Ff/NXP1werpvrlyCE9YXGl3EOlor/bLhAq6LbB/QwfAGnaDXvnwUVl/huBBTWz/AM3vQym37JXsSFHToBxUtCrBn+e2cItT4CwoFf6gcjkRWOu4lNvlVdD7KlHFr6GjS8tCiWa0cLeMvZbTyd2rsG3ceqCHtNdr4a3pziqI8FIefXCfAW45hOgwuV/v6bd70jVV63WLGnzeAMudaUl1dpkv7oooTnieI36vaGvO01dVOYLYLTXtPQYkRDANOIRc0LS5dwrXK3eb813dPnefyFLhOJ5z9LBbVUS4WPBJ6x+VNe8Ag8FRgvSBdyE0hYSGkxGB5eSasTh+uhG5YqIzBpuCdotuoYORxohwTaenRemO/WufS+aix7UMqZbK4hMW8WW/skD0+vlRqSt1X6bWCEgLp/fExq1RuIiGq2N0KYXvDWazF5O3Rc/Lmw0R8dVLwHm1g6pmWM+Sjh9jflty/bZ5u2OMGXvF728DPOSCOmOX6Xti3R6NxwtPp0bvbhovRZCJ84/N3pJSDDWPUNUnoYBGJTAtMBnZYiOCFGOucKtGA0DdPmz/W2ZONgOQ15nPBZvJeOzOrXCpS8VDsPQLJocUidfL8bAYKEGS3dp/LqFDDPaFgWpwPxPT3n3+x2ya7qgzZRzKkCD0UnoYT8FT7snGKs/h/Ouc/KvaWfPwf31jlTFjx1foQdowE2LqRX5ZS8snblhKYtNx30I6akGzs1xOMZUziBKhloSM6Wa3oMaZE06fa3UYsnOZE0m0IkLUJtkvxTAq+C8rz3/fsUDTV2KcLp0lO0T1cTiEC7qNudYdVpQ6Q9+LFWeGjNiDzjeGOYq9OKot2GIrMPrv2bkuwb677Aywel7vCrNhiNKeS068jqVzMTsfcs6WH1rvPi12nwCTRIRl6LHFTJ3HlhfsY3peGx/JV5YR+Kay9JstlIaCoYLW+eHXQYi2xZcYpD2D9DxkGmuE= +sidebar_class_name: "post api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Submits the chosen release candidate for beta review. - IOS only + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-review.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-review.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-review.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-review.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-review.RequestSchema.json new file mode 100644 index 00000000..ef3f6e95 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-review.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"copy_primary_whats_new":{"type":"boolean","description":"If true, whats_new from the primary localization will be copied into other localized languages where whats_new is empty. The default value is false."},"localizations":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"The maximum length of this parameter is 4000 characters."},"keywords":{"type":"string","description":"The maximum length of this parameter is 100 characters."},"locale":{"type":"string","description":"You can find the [supported locales](https://developer.apple.com/documentation/appstoreconnectapi/app_store/app_metadata/app_info_localizations/managing_metadata_in_your_app_by_using_locale_shortcodes)."},"marketing_url":{"type":"string"},"promotional_text":{"type":"string","description":"The maximum length of this parameter is 170 characters."},"support_url":{"type":"string"},"whats_new":{"type":"string","description":"The maximum length of this parameter is 4000 characters."}},"required":["locale"]}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-review.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-review.StatusCodes.json new file mode 100644 index 00000000..b9e711dd --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-review.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"202":{"description":"Submits the release candidate for review","content":{"application/json":{"examples":{"202 - Submits the release candidate for review":{"value":{}}}}}},"400":{"description":"Bad request","content":{"application/json":{"examples":{"400 - Bad request":{"value":{"code":"ERR_BAD_REQUEST","message":"Missing locale for localization."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"409":{"description":"Conflict","content":{"application/json":{"examples":{"409 - when previous app store version is not in an editable state":{"value":{"code":"ERR_CONFLICTS_WITH_CURRENT_APP_STORE_VERSION_STATE","message":"ReleaseManagement::ErrorHandling::Conflict"}},"409 - when current app store version is pending developer release":{"value":{"code":"ERR_CONFLICTS_WITH_REVIEWED_VERSION","message":"ReleaseManagement::ErrorHandling::Conflict"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - when the release candidate has not been approved yet":{"value":{"code":"ERR_RELEASE_CANDIDATE_NOT_APPROVED","message":"The release candidate cannot be sent to App Store review. It has not yet been approved."}},"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - when the release version does not exist in App Store":{"value":{"code":"ERR_VERSION_DOES_NOT_EXIST","message":"The app version does not exist in App Store."}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS app versions."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-review.api.mdx b/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-review.api.mdx new file mode 100644 index 00000000..2aa165a5 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/submit-release-candidate-for-review.api.mdx @@ -0,0 +1,69 @@ +--- +id: submit-release-candidate-for-review +title: "Submit release candidate for App Store review" +description: "Submits the chosen release candidate for App Store review. - IOS only" +sidebar_label: "Submit release candidate for App Store review" +hide_title: true +hide_table_of_contents: true +api: eJytWOtu4zYWfhVCwGLaQWIn7hRFjU4LT6zZMZrYWdlJdzcNBNqiYzaSqCUpJ67hv32APuI+yX6Hkixf08li8sPRhefwO7fvHGrpRcJMtMysVKnX9ob5OJHWMDsTbDJTRqRMi1hwg1ueRjLiVrCp0qyTZWxolRZ4P5fiqcFOWW8wZCqNF96JpzKhOensRWutQaHootLzUenAyWK9EZNcS7vw2ndLz6pHATB396v7E8/yB4Nrjza8FdpAp8FeuI3FHgoPAhnXPBEWS52yFDeAICPsIsnEjNsZrrX4Ty61ADyrcwEEk5lIuNfG9ouMJIzVMn3wVgRCC5NhX2HofeusRf+OO+6wx3Rl60SlVqSWdHBYISfOUc3fDClaeuKZJ7Ct2gq2frZuSMx5nAP9cuX+Trx3Z2f7YD/wiJH9wtjX4YE24NkU39gSiiJynB8E4YdONwz8f9z4wxF2SIQx/IHeXUlj4FUWqwmPC+zuUv7uNm14Ne7zfdw3Kc/tTGn5u4heC/wcwLfkjyC/6XduRp8GQe/ffncL+pZwDfObfZjXQidkp0pZJFL5eqzfAOu+kiOAr/3gqjcc9gb9sOv3ezuo99XU0N/tQy9rlKXKIjh5+mro7wB9X8kR6P3BKPw4uOlvQx65NDcq1xOX56RmLEpNNfrv99FfqHQKfK9O6u8B+mkGrsuokFRuGGSYccQyLziHSePskSnjKRORtHyMBDYWJXjMvItB/+Nl72I0DH/pjT6FFzdB4PdHYef6OhyOBoEf3vqBi9tw1Bn5Wz4oXXjFU9wnMKTd9rVW+hPKPkYBtdtrW0tvVCaARzXWH7YgE2ANlF8k5iImjq745DNNCPzbnv+L362Q//+YyyieH6JSCwGuI4alAqTL1lT9urCetyqfHCbOGS9COhZYAm1azUXEFuIoqQX+pd8Z+uFFp9/tdREyl8AIZzC49Q/l8O6OdTIbCpFVB9poz66BAco2uIZXOo2awlEvHUGPJOt3O0E3RDz9Pswgfu4Fe8CRJmORiqm0lUqUw/52RN1uSlBpKiYWngPKDf5uHYhsLwUwGbEs5hbyySsD2joY0Cq9IyUKt4lnaVyhrp17zCVV/XUH/tDF0v9nb6dhUSCplD5jlzI6DuWepUcQ9Pq3ncteN7y+7Iw+DoKr/VigYjMlkS24puGK5cYxD/lfYuDaAGdq9397qO334Gqd8pgNhYYIc9X5uhh86waAw4qOmjjyg37ncsu0ocKINiMqeqJKeNLKjVol+nK4+KCiRaHsRXx7k5sa/yZcE0DVgOOsLLBPVLYIMy0Trhfh04xbE6bF0FTKjZVCSqUQ3PHblLkZka2F2FSrxGVhqW9rimFPMo6pyrEjOi6SBJWusHo97OBhzNOHHM4wlNGo/1o3BT3J7KLBKPkiMeV5bJlzLb2b8thQrp14m3uaDTu41pyGcGlFYv7aL1vG7o6/u74gSAl/lkmesFikD3bGFNxDmboevAklJsUznCDwaEKjuMP7KBZPSkfmy+1yvr9JMVn+9Rb/UjnxMZvKNHKRvDN5lilNTFboMPdfzazNTLvZXPfLBiWgaExU0ozUJKcuVyQjnrtuW9IhzyQ9Ct0zdwXMHE2AuxuZTlW4Fb5mQm0TQNcLsShcYAgKSWC8CHManAshERoMopaKzHztrEYOPgpLC3IdHzjEuJgnirbicWjFs/2CQfhuLwilK4+COVR9XzzhVpuHvLsqMe7XLEMMpOh4mil3DnIHw7ZHATqtGLW5lNGq6YJ+Ss+LeBa9umncucydXokGi/OmM9lbjtGaboLLVbNsU6fJeixqzltNp+e0fGea83NomXMtidpdfZTyRX06BoDWKh2RXY2xhL9ABFIddFkBiZEaBj2gJDiO0tyxpetVdLCtzt1D97SozOL0XbNJJn8Wi+r0PBM8Enpvy+vOiCHvid9BhqC7HPt2rnsosTg2WF4ew6sjlEt6FyJi8aDme79oNi/xdXFe3yG/u91mt06nmnXqZxVJ1E92Cqh+sV839butNK8fb2Bd5/z9ihw4Vc6x0sYbAzOrJ2bnMvdxY/2tgxKjuITEvNU43/P927eXSj1SL61mMhVHpOmnt2/ZFs1hpKNe02Y/cDbTYvr+zaH0RMBPQW6mCRHx3JjZJP4JFppGGYs+Qvm+xP631lmNHjfYFb+35/jpQsUbZrl+EPb9m3CMhvf45sfbc2ejycTkhyb/8df013RUI153zkjgKIY+DzJGP/0oxjqnxDrHyNU6a33XgM8ekcs5GqeFtxmIEmPzHFQhH7QTQw6SK6ihkuKxmCq3WKQN2vRFDxRK4N3Th1xGwrnggCngALcHbPrvH3+y2xa7qgTZ30mQLHTcC4KBeop9WQfFJ53P/La2G/GNieiLfbAri50yvImhFbUO3CV9F8R4520SI0Ta7pvaDje6L2vVR72CH0EzM2JYaFgWvKjj1Yoeo+o1ffK7r8mvqGTpZlxwsxt2XjD/q6Bk+K/ZMSMqGksXjmPdgOoVvFB8F3S1WfIa7V68uCj2OB2ReC24N4CuTiqJzmQiMvvi2vuNrnM9cEeNcTnkJsXErDl5jn4dSJWthzv3bOlVcyPeFzqJRIlWtyn70VF2eeE+qh5ywzYdVz6hXzLroMhyWTQERLBaX7w6KrFuGaXHyQ9A/T+wCM1/ +sidebar_class_name: "post api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Submits the chosen release candidate for App Store review. - IOS only + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/update-approval-task.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/update-approval-task.ParamsDetails.json new file mode 100644 index 00000000..560fc774 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/update-approval-task.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"task_id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/update-approval-task.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/update-approval-task.RequestSchema.json new file mode 100644 index 00000000..483aa13f --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/update-approval-task.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"summary":{"type":"string","description":"The summary of your approval task."},"description":{"type":"string","description":"The detailed explanation of your approval task, providing additional context beyond the summary."},"assigned_user_slug":{"type":"string","description":"The user's slug to assign the approval task to."},"completed":{"type":"boolean","description":"The boolean flag of your approval task which marks it completed."}},"required":["name"]}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/update-approval-task.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/update-approval-task.StatusCodes.json new file mode 100644 index 00000000..ce3fc21b --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/update-approval-task.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"The updated task","content":{"application/json":{"examples":{"204 - The updated task":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/update-approval-task.api.mdx b/docs/release-management-api/store-releases/api-reference/update-approval-task.api.mdx new file mode 100644 index 00000000..fcf02fce --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/update-approval-task.api.mdx @@ -0,0 +1,69 @@ +--- +id: update-approval-task +title: "Update an approval task" +description: "Updates an approval task." +sidebar_label: "Update an approval task" +hide_title: true +hide_table_of_contents: true +api: eJy9V39vIjcQ/SrWSlXaKIHAXVUpuh+iF65FzZEUSKQ2h5DZHcDHst7aXhKK+LcfoB+xn6RvvMsSAkQXVWr+IMva8+bNeOaNWQYR2dCo1CmdBOfBTRpJR1bIRMg0NXouY+GknVaCk0CnZCTva0XlzkaxqYc92GIpzIxyi+D8bhk4PSVg3vVX/ZPAybHFcwADcUvGAsaKU7G2twH2pNLIGTmsevsEX+BIRQBWTC6VboJnQ39kyhBIOJMRnIYTmsngHB4XKVtYZ1QyDlarkxKEYxj8B6Q+b7YpSJPl9frZa/63nbzehETm0xL5pMFDqBNHieO9yGesQp/A6hfLBsuAHuQsjUtIJGQHAyvITwY2y5X/Owlen9V2nd8kMnMTbdSfFL3MMeDgeMv+kVMgRZyKZqczuGk3bno/X3Vavzcv4GNG1soxPXW+oflql+Y1mZmyfPwiokS9nOsrcN0FOUD4utn51Op2W1ftwUWz3XrCehdmQ33P8XYoJmlJJNqJkc6SF1Pn890FOUC9fdUbfLy6aW9T5vJAIerMhCRCmTDMkAqkkn2tvsu+62QSSRMJkCSUsSiL/2VR1OqI4jDYgWi6vUb7otG5GFy2PjTb3eag0/z1ptVpPo1OWYST0Ei5NSS0aNfdSBvhkAoQTyjkXgHvSpmA78/OdhPQQowmgZ51yczJiKYx2rwseOAi+P1ABwJvtXvNTrtxuRVnV0PmJlAWcQ/P4t5oLzIFew6crPtRR4sc7Fl+O5qlh1+QEviDskKxncq522w2k2axK24ne1Ss2Cz0SCxQa09nweqJzddARuSkinFS9JDGMvFB7Mc/EfxFRZwfGUWKd2LJ5+GBy32hk8gff0HTE5Jo5HFC0SCzZAY2zsZfx4u3H1nBBsJpkcN49C1SWPNuQs3V4PJKL9CHWqOpk73wxZoYxXK8P1xxP1HhRCCQqRWo+9ID1/PjGXWXD7N+XiVcQTrKZ1nIw8zPtPOgCvDTeTFhq0sVraprd/hazMGVn9VcvfmozUwM0+UQynTTuVxVTa5SpzMc1JhmKL/qvF61Ths6LdZsdV4DylwaJYdFfxT2ee+NZBajaoOJc6k9r4KFqgwVDsJSRen9ZZc3FMMI4Ih75Sb5QXORk2/w/uaW0fVvvefirlEeCZz9Qov1uJ+QjMjsuLxu9ATkg9sStY7DRy2IxnULwhrjRnKyvjysZ5uvWX8o3HydTZs2c43YarNDNVe+3lewm9VHdcZ3kxVHMtI+QuXYVTmOPpVn5Ln7O1V5xeITyh9hMa9Xajt8jo8vtZ5yr61FVccRI70/Pha/6YynjBgpdBxqc0KGzsUbKSaGRm+P9tUJMn8a6dBWYUIPlYmbxe9RXraSGsWZaSOnbwvu39TPNuzxBV7xeVvDxwUgjtAfZkzu7dFgCMmYHr27rfkYbUrhm6p89zn5nPQ2jFEvcczjMKLUUOjvUBCZjzQ0GZ9wzTpRP6v/UEHOpqwehhCwdNyUYiLnJGZqbPKrl/apSOjeAw8JyeHNlFTY6bMZyEGQ3dNxpiLyKdgTigI2+0BM//z1t7iti09rQ/ETG3KELDmptg7wfPZFQR66pT893EfD49mbfdE0LK9ViDN6Bm69JiwLWbkLHssKTM79ZbpUFn6zvmOjQyegzEbLXFJMvFrxazQMt8Zdf6MbXn4iZfkZtT4CFj0TxbedQg6/E4d4rxUgWXh58iM5wOOUFvmvCf5Z8D96XKdl1cfWQok46Hz1Q+7otMcYG+udSc+kc4tGGFLqnt3bfzQeIHIffsbuYXGdmOV3EyPv+QcQPj1V7SP3UurfLQNU6TjLrys5KOseK+G2yk69yhYP/lffvmRsK+g6M/zJce01WS5zDV+tyv350kGLUuWLk+ZEgPW/Dg4hHQ== +sidebar_class_name: "patch api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Updates an approval task. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/update-localized-release-notes-android.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/update-localized-release-notes-android.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/update-localized-release-notes-android.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/update-localized-release-notes-android.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/update-localized-release-notes-android.RequestSchema.json new file mode 100644 index 00000000..df99e31e --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/update-localized-release-notes-android.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"release_notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"The language code. Supported languages can be found here: [Google Play Supported Languages](https://support.google.com/googleplay/android-developer/table/4419860?hl=en)"},"text":{"type":"string","description":"The release notes text in the specified language. The maximum length of this parameter is 500 characters."}},"required":["language","text"]}}},"required":["release_notes"]}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/update-localized-release-notes-android.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/update-localized-release-notes-android.StatusCodes.json new file mode 100644 index 00000000..e967a7f7 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/update-localized-release-notes-android.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Update release notes","content":{"application/json":{"examples":{"204 - Update release notes":{"value":{}}}}}},"400":{"description":"Parameter missing","content":{"application/json":{"examples":{"400 - Parameter missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: language"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for Android releases."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/update-localized-release-notes-android.api.mdx b/docs/release-management-api/store-releases/api-reference/update-localized-release-notes-android.api.mdx new file mode 100644 index 00000000..070b86c4 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/update-localized-release-notes-android.api.mdx @@ -0,0 +1,69 @@ +--- +id: update-localized-release-notes-android +title: "Update release notes for different locales - Android only" +description: "Update release notes for the given app version." +sidebar_label: "Update release notes for different locales - Android only" +hide_title: true +hide_table_of_contents: true +api: eJydV+1y2kYUfZUdzXSceAwy1OkHEydDY5IyxdgV2DOtwzCLdEEbS1p1d4VNGf72AfqIfZLeu5IQGHDq5geRpb1nz/06e3fpBKB9JVIjZOK0nJs04AaYggi4BpZIA5pNpWImBDYTc0gYT1M2B6XRoO6cOBr8TAmzcFp3S8fIe0CYu9FqdOIYPtP47LTR4DY30KzGPkk5i4BdR3zBBkYqYF6+m4M2MgXFiUs3WLPpSZ9H4k8IinV9ItVOAiVFgARSrngMBjewFBL8A03tJ0EupdyE+Kzgj0woQFijMkDefggxd1pIepGShTZKJDNnRdQV6BTZgqbvzdMz+u/rgcJdfJkYSAytxzhFwrfOuF80GS0deORxGq1hMRp7cfDrnEcZslqu7L8T5+z0dJfEdek6i4XWxP5FDBATGeyCbGyPcAEFp+N54+u2177sDDve+LI7GHT7n3C3GLTmM7BhRhgmdInCiqKxSPQe4tQs6K1I8J0IWiziySwj68rJxp5IJzwzoVRUAS/1r0ER3rQ/4NpNv30z/PnK6/7eudjyasu4ovntnlyAsp7LhAWQiJdz/ZZysQNyKBcdzybhqj++6PS7T1jvwlTU99SyVxUf9nqWvJg6FfIuyAHq/avh+OPVTX+b8jCkJtAyUz4wnycEM4ECac2+0dxlPzA8CbgKGJIE7Fm27vSXedFooheHwQ54Mxi2+xdt72Lc637o9Aedsdf59abrdZ56hw0wgQSmwpSQmvHd7UqpReIJ+AYCktt6FYDmngB0835iacQN2scv9LtJfu9gHHC3279t97oX4+tee/jxyrvc9RKSIJUiMdTyMokWLNN8EuWeFaJdqp2uHHuzT9666IRKeMQGoPDEYR2lpHqZd2+sxO0HOugiSly/3dtybSBRIkOStQfcmT0oaY+Kgj1lFLT5SQaLHOxZfjsnj5x8wVzTUabo/DMi515Eabw+E4rlXCm+oNPNQKy/DrNW2Z2j7uRJvKkHy9WMIlJngyxNpaI6LD9o6s51a7IQFLTY3dahvrbplTajV6ExqW65rs4/1mfWoO7L2M0fsfIWLs8LpBbAHCJywjVUPO7ZWePHH747fR9G55C8djDkBh7Nf/Noe5YhOzyBbJPpFHwxFRvO1RlZxPxRxFnMIkhmJmRyiquxmteDBpU2FZYf4hufJg8q5M0R466KekF1tHq6Yju9o7ySqMokjT5pZjNJs0vLcbGMasXMpd2lCFZF0GoUtZqmKcqNyjGpViDXyqFE26rPx6NMRQi4nOD3G6+3csu1MU+QbYxl686brkUscbQ7byDKnCtBybBFVdjnPTvlWYTJcMoc81TUJwIzoqEu5N6k5JQYwTDEYQ8CA21zQs0BVhhG1XA5sG/zYs9HzKobUvELLMphLwQegNrZ8ro9ZKin1M5qwYxEUQLWvu5iLUcRhaiYGsvD3jaszSk1rVe1dyfXlj3tebfZaVU95nW6Hi5HKyI6ldYBYQhpffxerlNgqdXY5uBMCcgf0WLerDd2fDw+7kl5TxJVHiIyCgjp/fEx+01mtm+nAnsWz6C8bd9yFiqYnh/tKwMMbC2QvnbRBB7roYmj91g9up4qEWMY+xiy84L7N83Tij3+gbvi720Dfy4Q4ogZrmZgzo/GEwzS/dG724b1kTrwrcvffU4+J8OKMZZDFJHGBJAqQPnEFsVZ5iNMVEYJbGjDmqfN7+sYs3usmQwvESbkhi3QzZDPsYXFTFkzzDWFIoEHCzyBqbSLIanTps9GIAfB6NZmmUA1pBDscUUgNu2BPv3z19/stskuS0P2iQzJQ9KsVGqD8JT7ot4OXrcCMZ1iirAUbFsDXZzK05NO1afZ3zh0/scdrmglqlUXFQU7CdlapVgWEnTnbEoQmrTsBWtHhfDdIR3Cdg4xAIS1zPVHRasVvcbuUnR/HFUiY/spEHZ0QDmc8kjDMy6/8gphfc0OuVPKRbKwWmbPfQcf71E87HXR9mahH7R7/uFDvkdtSOaV4c65vjopLdq+D6l5du1oQ+ivb4a4dlKMDnE+hyj+QFdW/LUcpXU5Hwro3ZbU5JCkVaRe28p4b5WxeLAX9H1R2Fa9MiT0S17tNVkuc93FBJbr808HLdbKXAScwoCs/wX3k7N+ +sidebar_class_name: "put api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Update release notes for the given app version. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/update-release-settings.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/update-release-settings.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/update-release-settings.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/update-release-settings.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/update-release-settings.RequestSchema.json new file mode 100644 index 00000000..62d493f2 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/update-release-settings.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"earliest_release_date":{"type":"string","description":"Can only be set with release_type: \"scheduled\". The earliest release time the version will be released after approval. Must be a valid date time string."},"phased_release":{"type":"boolean","description":"Whether to release the version over a 7-day period or to all users immediately."},"release_type":{"enum":["AFTER_APPROVAL","MANUAL","SCHEDULED"],"type":"string","description":"case-insensitive"}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/update-release-settings.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/update-release-settings.StatusCodes.json new file mode 100644 index 00000000..7a9cb5e7 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/update-release-settings.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Updates the release settings for the version","content":{"application/json":{"examples":{"200 - Updates the release settings for the version":{"value":{}}}}}},"400":{"description":"Bad request","content":{"application/json":{"examples":{"400 - when the release type is invalid":{"value":{"code":"ERR_INVALID_RELEASE_TYPE","message":"The release type must be one of: AFTER_APPROVAL, MANUAL, SCHEDULED (case-insensitive)"}},"400 - when the release type is not scheduled, but earliest release date is given":{"value":{"code":"ERR_NOT_SCHEDULED_RELEASE","message":"Only the release_type: \"scheduled\" can be given an earliest release date."}},"400 - when the earliest release date has an invalid date":{"value":{"code":"ERR_INVALID_DATE","message":"The earliest release date is invalid."}},"400 - when the phased release setting is not a boolean":{"value":{"code":"ERR_NON_BOOLEAN","message":"Phased release setting must have a boolean value, either \"true\" or \"false\"."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - when the release version does not exist in App Store":{"value":{"code":"ERR_APP_STORE_VERSION_NOT_FOUND","message":"The app version is missing from App Store."}},"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/update-release-settings.api.mdx b/docs/release-management-api/store-releases/api-reference/update-release-settings.api.mdx new file mode 100644 index 00000000..fd82cbe6 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/update-release-settings.api.mdx @@ -0,0 +1,69 @@ +--- +id: update-release-settings +title: "Update the release settings for the app version" +description: "Updates the release settings for the app version. - IOS only" +sidebar_label: "Update the release settings for the app version" +hide_title: true +hide_table_of_contents: true +api: eJylWH+PGkcS/SqtkU5OrAUMsRUJxYnwMj6j7AIZ2D3l7BVqmGbp7Mz0pLtn1wTxbz5APuJ9knvVM8PPgYg7S2b50V316nXVq+pZeaEwMy1TK1Xitb27NORWGGYXgmkRCW4EM8JamTwaNlfa/cDTlD0LbbClzmqsNxgxlURL78pTqdCcTPXCjbEgNzMqrGCVEbNMS7v02p9XnlVPAp4/P6wfrjzLsaD92evAw33uwcADPkaCXtnIKi1YYdLDjpRrHguLtc5agg/wLEO4kRRQyu0C77X4PZNaAJXVmQCE2ULE3GvD/zKlHcZqoPPWhEILk8KxMPR7680b+vM/0FRQBO8zlViRWLID7iI5cxw1fjNkbOWJrzxGgKU7BHyRfex65lGGKFZr9+/Ke1sF+gMPGfEgjL0M01uH6WUhkj1AxByThskE7sH4Dg5YD4lVPwgmvf5956bXnQT+jd8Z+ZPxr0Mf/mNhDH+kReNDm3FmLJsKJBX+z9us83HsB5POcBgMYOqK3Xb6d/R3dP3J797d+F32zQybaxJnlhhp5bP41itoOAc8UZZRIoRZJMIrNs0sE1xHEgRt1tI50NpHGE1OhdgfjCcbMGWgezEOUB+7GCaEoc2+eBv/Xzw24wmF7VwxvK8EU6+KrBr2ghsyU5yP++7vDqnbGR8fzklSCsuVkFJ4F+Fh9pa0czZVCr+cobQ/+TAYgMn+Hp5htVmXMgv+LLaWmTN7xYQEHA2qqfLBsqL3cx4ZfCDkZcU0K8o84ZldKC3/EOGlJdOkMt7dfyLQu37nbvxpEPT+7Xf3It3bvIX53THModCxNKQFLBSJvBzrd8B6bOQE4KEf3PZGox4OqOv3eweoj81sob89hl4oucuJucqSi6G/BfRjI2fq9OPgrt+t0B+jMj0TVINkBmWYW9qgb7aO0Y8sT0KuQwaQUB7BNm3msiiaLURx2tiJaEbjTr/bCbqTm96134eyBv4vd73AP4wOJTcViZhLW5qELBy7K9sKgCdiZlFkwL1TIK0KAnqFtKQRt9gfXxh3q1Ulz0VfY6ESuViIrxLVLZPtBHCKEvQI0DII/Mm9H7gUPX3kO1MMqZLLWijJXKt466iQNgf0KNi/0dLhTWf8cRDcHh+HSMJUycSSX5qcWGb4NMqPQGKaKpgwW/bfVTX0HpjWCY/YSGhEwnytlb7sCN450a42dDI8dON+52YvrJHCELYg/l7gmb1o5YapAn0xdXxQ4TI3dhbf0Wympr8hIeEv1TRgWpljL9vSpOypZYPbH+muDli7RmtwpE9d+2Av6A/n2nKdVfZAK2OxO4bBThSRzWIBymcOVinNtAKPdXZbjDWcbftxbiZHitNGiK6/lSHtRFP2y8Nw/rUQrr9ZtYW2g0rReXL2fS3kSwbypAqpA2I1B9zMYBmTcSxCCTTR0mHYJcMRnWSxm8r35jAgyQcxvNkMPzSSn6f/cFLbpDglkArzkX1GM7sb3dteAwzWinBMYyXDNX0TiRp9b6hIGwXghtm9Y1Am55eCTEews5piyV1wsy6X12KeIHtjpGLjudVwpmpl6TWem7DyzLWkynT5VuzP63DOswgZ7C2sTU27AUiyPpUI2Yi6VEdRUwrlkBiZYbCTJx6dlUt4JzV0+yhvRyP3rfNc3JE2uQBnP4tlecVZCB4KfeRy2BkzCDmVqF7SgeOwWWfYQ4uLIqKouCuVU4YrQid3VIjBtmT9XC/OlNz2rA/TN79t7SfUYR6tKY65cvFJS442Y8Ht5oQccncT3FwM6XzKK5D33Ko3jyh4/fpGqSen6kVzU1FIln56/Zr9qjI3cc9lEjL0RhQRSv8HzhZazN+/qsoS8F4L1cw0sEV8rS9sHP2E5DL1VMsYLPfB6PsC+z9ab7bo8QFe8XrfxEsXJl4xy/WjsO9fTaYRT55e/XjfdDGaVMx+aPAfvyRfkvEW8UZeQpFqAcWEwKC8P4qpzuh8m9CW1pvW95AZ/oSUyjTpALdsiTDdYBzLR+22IRWIikS8OMNTMVdusUjq5PQsA7kRsFt7zGQoHAUVoUjYJh+I6T9//sXuW+y23Mj+SRspQid3ytg4vwUU6XjpE4jDQ99pL//v04wiXa34ahto+ig2IHZisirE6bO3K07Y0nZPHg70ydtUgBOmQqNQ6gtET0ZWuTbpaL2mr1F5mh6OPGwFyOlYKN2YAI1015czgX8TFLPjt+xUHKWUJEunc67Pe3j7BGFxD1DWD1hVaAt5z3+4zn3UxrR9u/Goj6+vyh2d2Uyk9uzahx31h2xdf8LqaTEsxPnkofkL0YhXh1K5oJ04uu9WHjLvMcuHkdwoKRlp275uPjndLN64509VPOxrYkkKvVJclVtWq1yVcYTl+vynkzs2ul1QTkQA9X8BAKi0mQ== +sidebar_class_name: "patch api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Updates the release settings for the app version. - IOS only + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/update-release.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/update-release.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/update-release.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/update-release.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/update-release.RequestSchema.json new file mode 100644 index 00000000..9a6b835e --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/update-release.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"artifact_source":{"type":"string","description":"Determines if artifacts are coming from the Bitrise CI or from external source via API upload. Valid values are \"api\" or \"ci\". If release_branch or workflow is configured it should be \"ci\"."},"description":{"type":"string"},"release_branch":{"type":"string","description":"The release branch part of the build configuration for the Release candidate stage."},"release_candidate_id":{"type":"string","description":"The uuidV4 identifier of the artifact."},"release_candidate_locked":{"type":"string","description":"Set to true to lock the currently selected release candidate and prevent automatic selection of the latest artifact."},"workflow":{"type":"string","description":"The workflow part of the build configuration for the Release candidate stage."},"automatic_store_upload":{"type":"boolean","description":"If set to true, Release Management will upload all successful builds that ran on the given branch with the given workflow to the App Store."},"slack_webhook_url":{"type":"string","deprecated":true,"description":"You can get notifications about release updates on Slack by setting this value. Make sure to send the properly formatted webhook url. Regex for validation: ^https:\\/\\/.*\\.slack\\.com\\/services\\/T[a-zA-Z0-9]*\\/B[a-zA-Z0-9]*\\/[a-zA-Z0-9]*$"},"slack_notification_integration_id":{"type":"string","description":"You can get notifications about release updates on Slack by setting this value. Make sure to send the integration ID found in Workspace Settings."},"status":{"type":"string","description":"The new status of the app version. Only the following statuses can be set externally: abandoned, completed_externally.","enum":["abandoned","completed_externally"]},"teams_webhook_url":{"type":"string","description":"You can get notifications about release updates on Teams by setting this value. Make sure to send the properly formatted webhook url. Regex for validation: ^https:\\/\\/(?:.*\\.webhook|outlook)\\.office(?:365)?\\.com\\/webhookb2\\/.*"},"approvals":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"due_date":{"type":"string","description":"A valid date in the future."},"summary":{"type":"string"}}},"description":"Tasks for the approval stage. Sending this value will replace the possibly already existing approval task list."},"automation":{"type":"array","items":{"type":"object","properties":{"event_name":{"enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed"],"type":"string"},"workflow_name":{"type":"string"},"pipeline_name":{"type":"string"}}},"description":"Automation events (workflow or pipeline runs) setup for specific event types. Sending this value will replace the possibly already existing automation list."},"timeline":{"type":"array","items":{"type":"object","properties":{"stage":{"enum":["release-candidate","approvals","testflight-upload","google-play-upload","app-store-review","release"],"type":"string"},"target_date":{"type":"string","description":"A valid date."}}},"description":"Timeline settings for the app version. Dates set here will appear in the sidebar. These deadlines serve purely informational purposes, no automatic action will take place at the scheduled times. Sending this value will replace the possibly already existing timeline."},"outgoing_webhooks":{"type":"array","items":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["release_candidate_set","testflight_upload_finished","google_play_store_upload_finished","beta_review_approved","beta_review_rejected","release_for_apple_app_store_testing_group","release_on_google_play_store_testing_track","approvals_completed","submitted_for_review","review_cancelled","review_status_changed","release_started","release_percentage_changed","release_completed","app_store_release_cancelled","app_store_release_completed","app_store_release_started","app_store_review_approved","app_store_review_cancelled","app_store_review_rejected","app_store_review_submitted","app_store_version_created","app_store_version_updated","app_version_added","approval_task_added","approval_task_changed","approval_task_completed","approval_task_deleted","approval_task_reopened","approval_tasks_completed","auto-upload_disabled","auto-upload_enabled","automation_added","automation_removed","google_play_automated_rollout_cancelled","google_play_automated_rollout_configured","google_play_automated_rollout_paused","google_play_automated_rollout_resumed","google_play_release_completed","google_play_release_notes_localization_added","google_play_release_notes_localization_changed","google_play_release_notes_localization_removed","google_play_release_started","google_play_rollout_percentage_changed","google_play_testing_track_release_completed","google_play_testing_track_release_failed","google_play_upload_completed","google_play_upload_failed","google_play_upload_started","metadata_localization_added","metadata_localization_changed","metadata_localization_removed","microsoft_teams_connection_changed","outgoing_webhook_added","outgoing_webhook_deleted","outgoing_webhook_updated","phased_release_disabled","phased_release_enabled","phased_release_paused","phased_release_resumed","release_candidate_auto_select_latest_build_disabled","release_candidate_auto_select_latest_build_enabled","release_candidate_build_selected","release_candidate_source_changed","release_description_changed","release_settings_changed","slack_connection_changed","stopped_managing_release","testflight_app_review_approved","testflight_app_review_rejected","testflight_app_review_submitted","testflight_distribution_start_failed","testflight_distribution_started","testflight_distribution_stopped","testflight_processing_completed","testflight_processing_failed","testflight_upload_completed","testflight_upload_failed","testflight_upload_started","testflight_what_to_test_added","testflight_what_to_test_changed","testflight_what_to_test_deleted"]},"description":"A list of event names that will trigger this webhook. These events correspond to specific actions or states in the release process."},"all_events":{"type":"boolean","description":"Indicates whether this webhook should be triggered for all events. Set to true to enable the webhook for every event."},"webhook_configuration_id":{"type":"string","description":"The unique identifier of the webhook configuration, that can be found in the workspace integration settings. This ID links the webhook configuration to the workspace."}}},"description":"COMING SOON. A collection of outgoing webhooks configured to trigger for specific event types. Each webhook can be associated with one or more events or set to trigger for all events."}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/update-release.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/update-release.StatusCodes.json new file mode 100644 index 00000000..5ffb2999 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/update-release.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"The updated app version","content":{"application/json":{"examples":{"200 - The updated app version":{"value":{"app_store_release_type":"MANUAL","artifact_source":"ci","automatic_store_upload":true,"connected_app_id":"f3dcf094-49e0-4fb9-b6b4-cc2279f2b3de","created_at":"2025-02-11T09:26:01.000Z","default_release_method":null,"demo":false,"description":"New awesome release","id":"bdf9620b-a5c3-47fe-8c4a-c412d4af7317","name":"1.2.1","release_branch":"main","release_candidate_build_slug":null,"release_candidate_id":null,"release_candidate_locked":false,"released_at":null,"slack_notification_integration_id":"ceec9565-0de0-4603-92b2-255e42c2d203","slack_webhook_url":null,"status":"scheduled","teams_webhook_url":"https://outlook.office.com/webhookb2/valid","workflow":"build-app","stages":[{"id":1,"name":"release-candidate","status":"completed","target_date":"2025-02-13T09:26:01.000Z","started_at":"2025-01-21T09:26:01.000Z","completed_at":"2025-01-28T09:26:01.000Z","disabled":false,"view_only":true},{"id":2,"name":"google-play-upload","status":"completed","target_date":"2025-02-16T09:26:01.000Z","started_at":"2025-01-28T09:26:01.000Z","completed_at":"2025-01-29T09:26:01.000Z","disabled":false,"view_only":true},{"id":3,"name":"approvals","status":"completed","target_date":"2025-02-19T09:26:01.000Z","started_at":"2025-01-31T09:26:01.000Z","completed_at":"2025-02-03T09:26:01.000Z","disabled":false,"view_only":true,"tasks":[{"description":"After quality assurance has finished testing, check back here.","due_date":"2075-02-11T09:26:01.000Z","completed":false,"completed_at":null,"created_at":"2025-02-11T09:26:01.000Z","id":1,"summary":"qa-check","assigned_user":null,"creator_user":{"avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png","email":"default-user@example.com","username":"default-user","slug":"default-user-slug"}},{"description":"Everything is adhering to our security policies.","due_date":"2075-02-11T09:26:01.000Z","completed":false,"completed_at":null,"created_at":"2025-02-11T09:26:01.000Z","id":2,"summary":"security-check","assigned_user":null,"creator_user":{"avatar_url":"https://bitrise-public-content-production.s3.amazonaws.com/user-icons/avatar-default.png","email":"default-user@example.com","username":"default-user","slug":"default-user-slug"}}]},{"id":4,"name":"release","status":"completed","target_date":"2025-02-20T09:26:01.000Z","started_at":"2025-02-07T09:26:01.000Z","completed_at":"2025-02-10T10:26:01.000Z","disabled":false,"view_only":true}],"timeline":[{"stage":"release-candidate","target_date":"2025-02-13T09:26:01.000Z"},{"stage":"google-play-upload","target_date":"2025-02-16T09:26:01.000Z"},{"stage":"approvals","target_date":"2025-02-19T09:26:01.000Z"},{"stage":"release","target_date":"2025-02-20T09:26:01.000Z"}],"platform":"android","store_app_id":"io.bitrise.test","store_app_name":"Test Android App","automations":[{"id":1,"created_at":"2025-02-11T09:26:01.000Z","event_name":"release_candidate_set","workflow_name":"google-ser-cred-test","pipeline_name":null},{"id":2,"created_at":"2025-02-11T09:26:01.000Z","event_name":"approvals_completed","workflow_name":null,"pipeline_name":"notify-stakeholders"}],"outgoing_webhooks":[{"id":"9e1817c7-ccca-4e0d-9155-0071cb07f966","created_at":"2025-02-11T09:26:01.000Z","events":null,"all_events":true,"webhook_configuration_id":"5623239f-28ea-4b8d-856e-8cb50073fade"},{"id":"a4410940-1f5e-45ec-9ce0-b47db15b210e","created_at":"2025-02-11T09:26:01.000Z","events":["approvals_completed","release_candidate_set"],"all_events":false,"webhook_configuration_id":"8352be85-758c-46bb-9890-03b4a8d70950"}]}}}}}},"400":{"description":"Validation error for outgoing webhooks","content":{"application/json":{"examples":{"400 - Bad request":{"value":{"code":"ERR_VALIDATION","message":"This slack integration ID is not valid."}},"400 - Validation error for outgoing webhooks":{"value":{"code":"ERR_UNPROCESSABLE_ENTITY","message":"The outgoing webhook with webhook_configuration_id '5623239f-28ea-4b8d-856e-8cb50073fade' cannot have all_events set to true while specifying events."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"409":{"description":"App version is scheduled or in progress","content":{"application/json":{"examples":{"409 - App version already completed":{"value":{"code":"ERR_CONFLICT","message":"Release is in final status and cannot be modified."}},"409 - App Store review is in progress":{"value":{"code":"ERR_CONFLICT","message":"App Store review is scheduled or is in progress so release candidate cannot be changed."}},"409 - App version is scheduled or in progress":{"value":{"code":"ERR_CONFLICT","message":"Release is scheduled or is in progress so release candidate cannot be changed."}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/update-release.api.mdx b/docs/release-management-api/store-releases/api-reference/update-release.api.mdx new file mode 100644 index 00000000..a0bcae76 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/update-release.api.mdx @@ -0,0 +1,69 @@ +--- +id: update-release +title: "Update an app version" +description: "Updates an app version." +sidebar_label: "Update an app version" +hide_title: true +hide_table_of_contents: true +api: eJztO2tz28iRf2UKlZR3XQLflERVNnu0pSSs2PKeRDuVtXSoATAgZ4UHdwaQrFX09X7A/cT7JemeBx4EKFHeXPLhsrVl0/Po6Xf3dA8enJDJQPBNzrPUOXE+bkKaM0loSuhmQ26ZkDDRcw6cbMMExVWLsFx3wWJGJYNZyYJC8PzeOfn84OTZDQNgn68frw+cnK4k/HbmAO6TBicdGN9QQROWw4jak8I/AC4PARhHTDY0X8NvwX4uuGBwZi4KBgcFa5ZQ5wROud/gDpkLnq6cRzxLMLkB8Ezi/GgwwL+a9C3XjBQK97BOIBwUZGnO0hy3wETMA0Vs/yeJ+x4c9oUmm7iETFyyCxQsuKVxwQwkT+aZYJ7QrPIM1u/n5x/n7+BYKnIe0SD3ZFaIAKcCjsNFniWAQWC2F5s4oyUTANeUBXCwhwdwFEg0DoNoMJu4kxkbuJPIn7n+oT9xg2A0OppFI38copwCwajaB4QCHaOpOxi5w+FyMDsZHZ4Mhr3BYPAjrAtZRIs4L9EGSa0zOCct4hhnk8w5iWgs2cEWg8/ZHaF3TGYJI6JUD4WiH0azw9HAd+k0GLuTo4i5x8GEusFkOAonNDoaD49grdGEYW/UGyoF0Bj4gqbBGiYSytPaeEDTkKMUPL/gcejJuFhZPNtreLh7Ls6CG1Q0Q5dZoHml98iYBjdemoHIjH54HLRmJcxvpDJgLJhND4GxIQricDB2ZyN/5I6mUzYZBaNwNBg7FtQd89dZduMVIi7PyGleSFRs0PSwiBlaRM5oIpurnXWeb+RJv58VeQyjvSwCpFgvyJK+WeiP+qCJyqTuMnETxdkdigHZ5ILiOOqwFdMGiMgPS+4b4t2SO04NMzgCTCHXmFGxYrmnltQ0atzSKNgttjRv6I7amlcC31p53NZRLqkf1yR2y9mdl6XxvbaTxwNN1aikapVlq5i5m5jeu8aiXkbW4Z5ktZHdRdbsq8kal2SBLEUGkpYvpKZ9dic14z2FNHIHbbE/Rw0iJ2+0CjY9yTyC4EB+LkCD83tCpSzQAzCyppJEPOUSzINArMrB/R8QMJbghvhgVGTNBMOIFRasIvlol6er+GQxbBKnrXJfv2msSBZJQgWQ6PwM/g1RQ58uJV+lAKSQTDQAZ8KMQcS4pSCDLRP3OQQ5sMZN4UNgck2ockHqYREgu3py3KMJ/SVL6Z1ULgDhuRxWyr4G6RqX3ttAtDxwIIhyPMKMurj+P0yQQwCwBIeMhtVXKeeFPrYx6qqxR1TOphjPIC7e52sQEuGQV4QgHfydZwQCHrF5A9lkQBln8l8puFFdcBaz/1/iu7beZbIdCl7mW0aDfXwLeIyjfX3LcLAcDl7oKTH95AmLecqUg1Hhbkd02zOQIX8smM5wsmfkqMOp++89XXV9eyWgPWWBfAGk8ygTCR6fhiLjOhRirlnmlDzrGdXtoZ9tLDDKsYRxMtcAyFzlFDZ1xTy/lljsa4jsFmzDa+peLUmTLK+lM14zsKMiwzmha9Dd8I0SvlmGJltLCr4Ko1JWXt0ItvDRvmHrdEfljfcuiO2GrbM4xKsPigISuFUGPtHmdxXbnBkbHg+PgiNI4wPqTtggdGfDKSA6OBoG/uAIEurDF2T1ihJp8aNx7NkRHYptggl+J+Krop7WTg9H49F4FkFuwwAT/zh0j6eHmMH7U8BmHFG4X1jmOnQyGcJlZOAOoylzJ1MWuLMA0mF/chT6w6k/Gg5echuxWH7ewf5uNblukmh8xBM0Ho+nI58dT92j6XEAqbvvu7Pj2QDSGn9Cj8OjwWw6AIk9qv8OnEnXBfMTJtwKJmFCZIKAkRErYVJK+EX3zYm6b76hIcHbMKp2/Y4ZZCFq19nFhfdp/m5xOl8uPpzDAQmTUjuI5Roir7pwkNp1hSxOMSKDVhJ1S+g5hig4a08qdqDx8fyHiw9vzy4v52/enXln58vF8q9bCLEWNHLH8zXZJR3yah8FfEVAA5CgNb1lpBI+pBk5Zhyo5eRuzWNG5IYFYI2IgF6D5Fu5Dtty/ZiCX1tngv+iNO5F0hsCRxv7d/Jt/nH5pw8Xix/PThv8amyu0By30fyBiYRLrEOQkKX85biOAdc2kB0I/3B28X5xeQn65p2enS+2sG6DqVCftVGfVzUU1Mvy+ktA9XhKwO5XAmC/lKAZEFQHTWNwOuE9qaWP3cS9/XD+h3eLt8sGTabihQgCTnANoTHRaREB32PVz2ckyUIeAc3WqiwalxhBwY4xVTFQSspegkgXrCbLGrCJzGw5hpResoZusKbpqo3tPvL4Svb9Y5A1+jQctfXpMoetVIQEFISlkpGylPgyDRqOgBm7ge0g/3I5Pz+dX5x6wIOz88sz7+LsPz8uLrZMRHlmn6Us4rkFCZrUPg79bw5es6z8YcmxYsC0KxQtgEaBCnrJBAiSnKEnfxnxUxUNugHtIHxxvjy7OFe1zYrOywwLiNrbpzm5E5kq2RrsTVR7k4X3GtiT+LUqwJn/E7AE0z2BReqca9xbldXtkvF26fIUq9EJJGygjBGx20EcAvmeIPaRyBIlhzc6LyZvF6i+aph9MVzS55FbTsn8hwXRN4OejqlEsUzDvALy+JWDAK6cAH71yCIizXonTtrkEq3ExkVQANAYuc6KOESTMAAgA2sS1SqTtwuqz7EFg7W1RoPUBphDskhxQpUTSSNel9p60TJidWfp1dFo1mb3QaYoePhpQjgEFSzEgkIaVKzIdsC39d3nzrisJQvwN27TtlcIAUfG95BOxNoI214Ko8BGqJSClEV8swFZY1CNscuSNzGuarT7cKHUin+EMHa1G0pE/CyD3WkLE1DYWm51UB7ynqYAO1HGzuPYGAGmZEQWQQCOISpija4E7Ch4PwrMSRWmKw7ss7qm0sJqtCQbj4TRMg4qOjqq6l28BAEFNK+aSk2a/poVyCQCV2lSr/WD1fqQtZZCL0yvDLC+VMm1j5qR56q8hY5d2XoPeHEDvAabRZwlAwVBxLWzAmXCWzjNUZtsJgx494CTK/ZFCe+2TMZPyH/pmtLVVR/+772+uuopkuFv8FAwBDfgWwgZEn4uP1P3l7n748CdXcPC/putf9f/+ZuKeU92N55TzH8O67YuMVFWwATkD38B3ZAbCr73UsOSWilM2Wofq0ohkzL5nHUqtTYo+ZCCwHA0ymJQQkRXrwZakG7wxGgONhTE9ydAONhblrLwoEo5vWoB1jtZWiTqcmuXNqpg1Vrn+rGzFfR/IJUlnvJPV+hvvj9ROm32/c20tr6FId3dggXjw+m335f6Xna6lDkoV1YW0yq+UCHoPRZ5c5bI5zOH5yJoVZ9+jvNzTStR7pZr7xYVeWHdla02t7vZ24HcWWKbpHTmlkrjw0Hhwak3xKT9rmCbGA1CCSiDy5gPArJXIPaFq+5JBQ17MZBzyrwRFRpseCEv68Wzh1LTd9X1MChGMV+tcxOCPNvpgUld5POw3NoIU/U1Psupp29EnqaqNSzYTyp41+pGwFVcHevSpoZtOkveSmTFprYWPGEbEbs4F1T3CjrLVLLwE46GoQ7U6CjICq8Au1txbBBTQ9q3eOa+U0PC1NJrI8ByuCmgMnQsr5DAivi2Om8VLzsUfquSuYe2zkvVMeUV8k0ZuUGFLUAiilR+i06m2Cjd1mUZyJh0BoXnyF+t3RUupWpXbYGvVWxTfW/pdKOp0Kjsl7pdNQs6OwiwyVVq5dZURJf4u8TXKPq/xCH1Ot2MYYx1/A2XUwXCUxUoMNZht1VLAxYwKqybk5Cf+1T08J0MxJYQZBKruxWmKCAu8IEgLJ7qaAFAwf3AIIiRyQMIU7XsmerUWR2CxXOipQ5JozqoLCSgUH+1tljNUGrSUZr/VY5wn/2l5P7tLP/FzvKg4/1W/eCO2Sf3VojU57bZ35rbdeS2gFpzJQsbk8aGPdN86Zwz79rMnB2lYWjHlMA8TBd2jFZ83Rpvcqg2E7LuccHAjNL2RFNd0FsYF+qVfeHmMEvro9rpVNhXQ4IlRhR13TULQB8F5v5F3pDLMyvLqs2zSzcULhPPLxMMcsfWui417JqHSwCTWA+BWPBLkw97Lq/Eu+eGbqa2LaMxa3nSZa71hQ2P8iwXuldHlLdFaTRnFyTrUp/YWlGWgFsFq6LdfO+ercjtnq+4mvBAZDKLck9fEE2huAlkO5yVp7cmKmNsTVW+YbNW7yMtB2tmtzVTWd7WRKntW+OVereDHxqDpwtqni6jmZeftfNfsKvCbeeLUlPt6240q2JvRxippVVdMclkV7UpXX7plBs4Z8itQi/BqhrKovbko0oC0FW3w0n3glrY6F5Qjx21FcBjSE/8QiGodLvS/ieXPbNC0ddcARRgnRDJbbw36lzRhUSH8XakTLs3duJ9t6ZgYplyIqX57JqvJLhrhbWz6/YNSl1WsAqlr0J49TKlUp0IC75aMaGzXGObNtk2V64gE/pFfKgKNfZqpdNpifcwzJmYtCm7rQMZvuoaQO0FxfPVYLCKQEG8WzOA2MSu1q4wyEPOjrcLrAqbJjzZKr5r61TYWSi4g+GjQr1Hl853PurYq6GQ8p/huHZDwR7ZAHughWDKfWXxMTc1eV2ArJcora2jdIAbi1OQbHojd59ga9sluM6b2tsP7xfnfySXHz6c98gcIMS1HkPrrUa9c6T4q7Vn9537jAbrCj1NLJUyC7j64kGV5TO4JwKABNvQRucQnhVhdURNwmXP0n5SgF96BPiph/ri48Tp4/3XpJyy/8DDR/SAqvOoX0bpx5UPPqjqx4t3j3178U7KnkP/dtS3N2g1J/u3+C3BLRUc9UnpstmvC37qJWTtySbd8PLtG886tUajRBAMAThVo0I1KLXMrqsvYy7VqLYi/X1MdRPc8D8zdRVE2Gu4j6pnmlsvO+ZLApEBW6qg+sBfiJyqvwjpgKov2Adq5qWIrtsho7FxelG1WM90f7ezRbrLSsrh1tcYrZlmP++peduPq9bUvlIox57+EmafLzJKUOX71XqhvevTiurwqpjcep9esap6rlwdVb0jNoWa62Y99fPD1710LE/Yfl1YO+cr37zWIHQ/Saye4e314O7ZN4XlgY+o+lGmTILncf2lSK2RiMqun6WU35GBSduvrpxb/b1QU0ivX7+Dw1Xr3pSxMohAAOn716+J7YtEPFXtdCxlnZDfUbIWLPruVZdjAVN1wyyQfdjCvvTWeRJ/DzojexvBUeDnIIzvDO6/HQ0q7OEfcCr8+WkIf5wCiFdEs/+7V54f0/Tm1e8/DRWN6I9/16e/v0qv0mWFsQ77PpbSbP8SOzV/YL4o0CUMIVsYDUZHjf4MRqp7IFM9iEs42oUJAKbZhYB9FmVqMUt7eOiTHNBAgLvuqoCIqVjQQQo+ScIzgKb//e//IZ9G5L3dSP6IG5FCVVvOZA7gUfZGk7u/QdwWbe2dyBNfLRoPm7MveR+uZeBg4UjTNNPxRr0pLeMNbDnhqky+zvCd5WfnQQcaET8+4jC4UTTrz9dVNNG+Yfst+k5kv7kwT4e+JbsQtHEhvVdBSz2yceDnDUOPAvgpkzGBAk/XE2/NhwVL3F5tbD2iwWe6esc8CNgmf3LtdS1SQwx6+yesEJqXOol+9iOoqszRO41ltjGPvx/02IMDOrEqtBvSQB91d2ndDII3KgiaH+pD0i4+NAOcZQr+iXR1bnl40CH28bFcr6d27iiDsGF5qt/9/h1nCMcu +sidebar_class_name: "patch api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Updates an app version. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/update-what-to-test-description.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/update-what-to-test-description.ParamsDetails.json new file mode 100644 index 00000000..5462887f --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/update-what-to-test-description.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"what_to_test_id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/update-what-to-test-description.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/update-what-to-test-description.RequestSchema.json new file mode 100644 index 00000000..c8184898 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/update-what-to-test-description.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"locale":{"type":"string","description":"In case of iOS platform here is the list of [supported locales](https://developer.apple.com/documentation/appstoreconnectapi/app_store/app_metadata/app_info_localizations/managing_metadata_in_your_app_by_using_locale_shortcodes)."},"whats_new":{"type":"string","description":"The description."}},"required":["locale","what_to_test"]}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/update-what-to-test-description.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/update-what-to-test-description.StatusCodes.json new file mode 100644 index 00000000..c11da394 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/update-what-to-test-description.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Update \"What to test\" description","content":{"application/json":{"examples":{"200 - Update \"What to test\" description":{"value":{"id":"891960ff-7b4b-446b-808f-8e712022c4c4","whats_new":"Awesome test description","locale":"ar-SA"}}}}}},"400":{"description":"Parameter missing","content":{"application/json":{"examples":{"400 - No release candidate":{"value":{"code":"ERR_BAD_REQUEST","message":"There is no release candidate chosen"}},"400 - Parameter missing":{"value":{"code":"ERR_PARAMETER_MISSING","message":"param is missing or the value is empty or invalid: whats_new"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - App Store Connect API credentials":{"value":{"code":"ERR_UNAUTHORIZED","message":"The specified connected app does not have a valid App Store Connect API credential"}},"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"422":{"description":"Invalid platform","content":{"application/json":{"examples":{"422 - Invalid platform":{"value":{"code":"ERR_INVALID_PLATFORM","message":"This endpoint is only usable for iOS releases."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/update-what-to-test-description.api.mdx b/docs/release-management-api/store-releases/api-reference/update-what-to-test-description.api.mdx new file mode 100644 index 00000000..9062c3b0 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/update-what-to-test-description.api.mdx @@ -0,0 +1,69 @@ +--- +id: update-what-to-test-description +title: "Update the selected 'What to test' description - IOS only" +description: "Update the selected 'What to test' description for the given app version." +sidebar_label: "Update the selected 'What to test' description - IOS only" +hide_title: true +hide_table_of_contents: true +api: eJy9WG1vGkcQ/iurkyonFnCGksRBeRExJEG1sQvYVWuj03K3wMbH7XV3D0IQX/sD+hP7Szqze8fbgVPUqvlAjmPn7ZmZZ2a9cAKmfMljzUXk1JzbOKCaET1mRLGQ+ZoF5MH5ZUw10YJopvSDQzZEyFBIc3rEpywiNI7JlEkFv5ScgqOYn0iu507tfuFo8cjAxH1/2S84mo4UPDt1ELizAooUSVcLycgHpilpcKUlHyTGMZAQMZMUv7SClZ/oV0/0wKvGRhQFJ6aSTpgGvcZyBF9AhgfwE8coY6rH8CzZ7wmXDPRpmTBw1x+zCXVq4Os8Rgn0IBo5y2VhpWQGJj0tPITC+xca+3hYxRA2U/h75ewM/9ubjacSAEZ9EWkWaRQH/EPuG5jcLwp1LBz2lU7icGUFUP4nauHwlIYJwweOiJ+/Lr9+eTYcFl8NqoNitfpyUDw/Ox8Wz9mrcuWsUvGrfhWcQXyUF7EZiNRnTIkJM+p3fA6FT0MEhMpitw544L+CU92Hwk2WTTLhSiF8R8VcNTG3BZFQ0FQx4tMo4IjAVpC+CNCfZqfjfag3vE7z59tmtwemJkwpOsLfemMG1ckVifYoI/5YKCjwNAwwmff7gL2beqd+1ew1O95Vq9tttT9tWTXFjFZTLSTtOKMJ37NJrOf4lkfwjgc1sk7CGtjynvKKaKLHQvJvLDgW0zIEiM1rO/ZCRBGQBanftIgP9Q9qOA3VoYBv2/Xb3ufrTuu3ZmMXYaJi5vMhB+LxrVZ4Ql4JBEPkNRnTKSOUmFi/60OaD3R3K9xjPdsSXqP6455yZdJkCsgRfODHQ/sj1k5OyaHaaXZM0Vy3vUaz3drxOq9m7Xo173onLWpEeSiS6GjXq+B6XskB19vXPe/j9W07XwLAjCKRvukuVDNgqaaV9+VK3vuuhl6kMiDgJANeJSs2Pi6KcsVMokPKDkTT7dXbjXqn4V22LprtbtMwSKuTK3Bo2AGL2JDrTKWCYs6Zy+bqVg+U1gBU9gDQsv1P4pBqkJ8cGXcF487pOBBuq31Xv2w1vJvLeu/jdecqHyWLgljwSCNFiSick0TRQWgj49fdjEHVOqgX+9i/BQHIiIakyySsFqQppZDHRfbC0PF+RQfDAzpu1y+3wurCMNNjpOAZWCYzKcwoT73HbMKg+yCCuVX2pH+5zUAMvkCecXmRuOpobn3PBuXuBlHIwQTNAnUjhgbcLH0kG1lYSyGsVHjgXiVxLCQWlVWv+s/GWseq5roBm7IQHSih16zki4kbCD+ZQCw2AnivkHDTyqQxx1eeeWeeACQKE5GaLzwaCs9Y4d+MvHInNKIjiGF1EA55c2h4DwUGcy/BMWeFmKeAdDVmRj2HStlaML6HCVLJxpuSk6XJ9vF9Bm5ha6tz+jafmGsR2N3OH5utEna8moNhFdMlV7kLHizdAQRSDDYWVhcVFrUookJ3sbM0Ls1qjEVo99NEhqB3MYD83XYul27aGUUDFEPk3WnFNQAXs65xp2XQMqWSY1OZUknlbQsNaRJC8TlZXiFNpQEHBxUrcbEXKusSQTUE9JAZ12N7E8BaZaZP++ulvmveGsvpar/KBxj7ic2z3XjMaMBkzuRNvUeggLC75By30ATsmuFNQ1gdCtnGnc1dUz0mhdhDnXW3NW2rb3bLuiI299Fs+Ua/hsL4y7U5ns2sqxXixhO74mT3E8TbPoLEtFIq50I6Pb0U4hEJIqNvEQao6f3pKflVJDjPyJBHAQH2x86skTeUjCUbvj3Zl3XAsQjNp1wQYV9LYz0J30OxqFIs+QRQawNCb1Pff6icrb2HL2AVPu/K8NEAFSdEUzli+u2JNwhp9Hjy7q5sYsR1641L3z1ED1Fv7TFkPwxx8AYshl6nSBawRXxkA5lgvspAJbD2vyoBZo9QIonEWyNcJ6CR7YY24SNpxPCCAYohB0bxgA2FOcyiEhp9EgGrBNAtjhIeMAPBnlA46EYbENNff/xJ7irkKhMkn1AQI8TEx0JpUI+5T8vr6BsvTBIgWJxou/nfIP3/+CKd9pVmX7UL1A5tBbEY2liktHTvbNISiNTM5TTHTGlLZNyEB3evtNDjcJXRqHNhSUmGyyW+hpaTeJnvr5nHEBgYwGcgyyFs/ewJWJ51Uvp9Tg6FlXFINDcEZ2azA4+PwCjmEo+38f/R4i48yz6IpJyGwdtTF9ZgsYe61lpyox+dtxJ132exfvJsf2MKAV1efMaMpvvFxC4rks7w7w50Zl0WBgFDyuYdUCKNRondX6xSZFDk1G2+fjR8nT6YP9fsA2WbizOE8BPj2iuyWNhpsFyuztufDkqs5kWacQQCvP4bVgJtmg== +sidebar_class_name: "patch api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Update the selected "What to test" description for the given app version. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/upload-release-candidate.ParamsDetails.json b/docs/release-management-api/store-releases/api-reference/upload-release-candidate.ParamsDetails.json new file mode 100644 index 00000000..92be4663 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/upload-release-candidate.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/upload-release-candidate.RequestSchema.json b/docs/release-management-api/store-releases/api-reference/upload-release-candidate.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/upload-release-candidate.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/upload-release-candidate.StatusCodes.json b/docs/release-management-api/store-releases/api-reference/upload-release-candidate.StatusCodes.json new file mode 100644 index 00000000..9c056a18 --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/upload-release-candidate.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Upload release candidate","content":{"application/json":{"examples":{"200 - Upload release candidate":{"value":{}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"401 - Unauthorized":{"value":{"code":"ERR_UNAUTHORIZED","message":"Unauthorized"}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"403 - Permission denied":{"value":{"code":"ERR_PERMISSION_DENIED","message":"Permission denied"}}}}}},"404":{"description":"Release not found","content":{"application/json":{"examples":{"404 - Release not found":{"value":{"code":"ERR_NOT_FOUND","message":"The resource cannot be found"}}}}}},"412":{"description":"Standard license required","content":{"application/json":{"examples":{"412 - Standard license required":{"value":{"code":"ERR_STANDARD_LICENSE_REQUIRED","message":"This benefit requires a Standard license for the connected app."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"examples":{"500 - Internal Server Error":{"value":{"code":"ERR_INTERNAL","message":"Something went wrong"}}}}}}}} \ No newline at end of file diff --git a/docs/release-management-api/store-releases/api-reference/upload-release-candidate.api.mdx b/docs/release-management-api/store-releases/api-reference/upload-release-candidate.api.mdx new file mode 100644 index 00000000..a4b6d8ed --- /dev/null +++ b/docs/release-management-api/store-releases/api-reference/upload-release-candidate.api.mdx @@ -0,0 +1,69 @@ +--- +id: upload-release-candidate +title: "Upload a release candidate" +description: "Uploads the release candidate to the Store." +sidebar_label: "Upload a release candidate" +hide_title: true +hide_table_of_contents: true +api: eJyVVu1u4kYUfZWRpSptFHBgs6qENrtCG7ZFTUhqIFKbjdBgX/AUM+OdGZNQxN8+QB+xT9J7xzYfMaxEfjiDPffcc7/OzMqLwIRapFYo6bW8YZooHhlmY2AaEuAGWMhlJCJugVnlPvSt0lD3LjyVguZk2Y02tkFu9bk0wm0GwkwLu/RaTyvPqhmgp6fn9fOFZ/nU4Nprpyl7BG0QyrAaKzDYFgT3plzzOVjc5XAk/kCnIkIHgqin3Ma41vAtExqQkNUZoPMwhjn3Wuh5mZKFsVrIqbcm/xpMii7B0Pfm5SX9O5SQai7QU6ikBWnJhqdpIkKXCv8vQ4YrD175PE020BjWUSzcseBJRou1+7vwri4bB8hIntlYafE3RKcRQDgisGu/4xSRIkpNJwhGw157OPj1Puj+2blBH3Mwhk/hrfMtzXdVmg+g58JQMVkEUpzO9R1yrYIcIfzQCe66/X73vje66fS6b1hXYbbUr6rUy86TyrKJyuTJ1K922ncLcoR6734w+nI/7O1THrjZMyrToWsSghlDgbRh32hW2fctthTXEUOSgG3NNsNwWhSNJkZxHOxINP1Bu3fTDm5Gt93PnV6/Mwo6vw+7QedtdMJgOBImwpaQhvGqu4nSTm2QuITQQsSQd32TgPeHprWLMWrJE9YHvQDNOlorfVrw792oHgY6Eni3N+gEvfbtXpx9hWIVo9KwF/TMXrRyolOwp2+KRDPNrHeRa1fL85FcbVHooL8S0dovxKK2EQs/cyriZJWo5WqY6QTtV2PcOgxut2ZzLpHOHBn4i6ZvSLhrxTfjLxqIsuBa8HERfGGfJ3bCswRT5sXWpqblIzlRHwtUTwN1odB0P/fUtjklRjAMcdiLsLErolNhcNV73h4IfffWeS6OhY1Ko7PfYFlqeww8Al1x+dAeMOwNyrle0umUod/2QxenJkkMbi8OiVK4XNU9yr+QE+W8CZvAztzfbfLlcGps92SibOVLtFg0640KofPzW6VmVPSye1USEdKn83P2h8ponNlEyIhh88egocU+cBZrmFyfHaoZZqEWqdD4aAKv9djOk09YalNPtZhjzD2M77rg/kPzcssef6BXfD428HGDEGfMcj0Fe302Gidczs4+PjZcjCaF8IPPP36VX+VgyxhrlySkOxGkGnBgcABRRL/AWGeU7YaxrHnZ/LmOOZthgTON94OYW7bEMGO+ADYXU+3MimuDhBcHPAZMDm0GWSen381ADoLZrU0zEYFLwYFQBGKTD4zpv3/+ZY9Ndlcasl/IkCL0sPCpMhbhqfZFc5RXHn7wkN+r72orJCfelIqutvBq/TTh2NTIxQ3tqhj+J293+NGk5a42lfnHd4UC4CDFGA2ZrvLJ18l6Ta+/ZaDptvW8HW+nEpEwtEbdmfDEwHei+zEoxP4ndox9Oahy6VTEyaKHyxmOrbuXrZ9xVzG55D3/0A5DSO2OSUWQSSE2+vgwHOBeGuB9cZg5cSgW7l55iM7+4Jfc6Lm+OGKyWuXSg5ks9+efjlpsxKmInCJAnfsfRyfjSA== +sidebar_class_name: "put api-method" +info_path: en/release-management-api/store-releases/api-reference/release-management-api-app-versions +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Uploads the release candidate to the Store. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/release-management/api/_category_.json b/docs/release-management/api/_category_.json new file mode 100644 index 00000000..145f3220 --- /dev/null +++ b/docs/release-management/api/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "API guides", + "position": 7, + "link": null, + "customProps": { + "icon": "Code" + } +} diff --git a/docs/release-management/api/adding-and-connecting-an-app.mdx b/docs/release-management/api/adding-and-connecting-an-app.mdx new file mode 100644 index 00000000..0a64a192 --- /dev/null +++ b/docs/release-management/api/adding-and-connecting-an-app.mdx @@ -0,0 +1,152 @@ +--- +title: "Adding and connecting an app" +description: "Add an app to Release Management via the API and connect it to the App Store or Google Play." +sidebar_position: 2 +slug: /release-management/api/adding-and-connecting-an-app +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Before you can manage releases through the API, you need to add the app to Release Management and connect it to a store. + +The Apps sub-API base URL: `https://api.bitrise.io/release-management/v2/apps/v1`. See the [Apps API reference](/en/release-management-api/apps/api-reference/release-management-api) for the full list of endpoints, parameters, and schemas. + +## Adding a new app + +| Endpoint | Function | Required role | +| --- | --- | --- | +| [`POST /`](/en/release-management-api/apps/api-reference/create-app) | Add a new app. | Release manager | +| [`GET /`](/en/release-management-api/apps/api-reference/list-apps) | List all apps in a workspace. | Any | +| [`GET /{id}`](/en/release-management-api/apps/api-reference/get-app) | Get details of a specific app. | Any | +| [`DELETE /{id}`](/en/release-management-api/apps/api-reference/delete-app) | Remove an app from Release Management. | Release manager | + +To add an app, call `POST /` with the required fields: + +- `platform`: The app platform: `ios` or `android`. +- `store_app_id`: The app's store identifier. For iOS: the App Store Connect numeric app ID. For Android: the package name (e.g. `com.example.myapp`). +- `workspace_slug`: The slug of the Bitrise workspace that will own the app. +- `store_credential_id`: The numeric integer ID of the Apple or Google service credential configured in your workspace. Required to connect the app to the store immediately. To skip this and connect later, set `manual_connection: true` instead. + + + + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/apps/v1/" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "platform": "ios", + "store_app_id": "1234567890", + "workspace_slug": "YOUR_WORKSPACE_SLUG", + "store_app_name": "My iOS App", + "store_credential_id": YOUR_APPLE_CREDENTIAL_ID, + "framework": "native_ios" + }' +``` + + + + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/apps/v1/" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "platform": "android", + "store_app_id": "com.example.myapp", + "workspace_slug": "YOUR_WORKSPACE_SLUG", + "store_app_name": "My Android App", + "store_credential_id": YOUR_GOOGLE_CREDENTIAL_ID, + "framework": "native_android" + }' +``` + + + + +The response includes the new app's `id`. + +```json +{ + "id": "YOUR_APP_ID", + "created_at": "2026-01-01T00:00:00.000Z", + "platform": "android", + "project_id": "YOUR_PROJECT_ID", + "workspace_slug": "YOUR_WORKSPACE_SLUG", + "icon_id": null, + "icon_url": null, + "app_name": "My Android App", + "current_user_release_management_admin": false, + "framework": "native_android", + "latest_version": null, + "latest_version_date": null, + "latest_build_version": "", + "latest_build_version_code": "", + "license": "basic", + "store_app_id": "com.example.myapp", + "store_connected": true, + "store_credential_id": 12345 +} +``` + +Save this value — you'll need it in all subsequent API calls for this app. + +:::note[Store credentials] + +The `store_credential_id` refers to an Apple or Google service credential configured in your workspace. You can manage credentials in Bitrise from **Workspace settings > Integrations**. + +::: + +You can connect the app to the store later using `PATCH /{id}`. + +## Connecting an app to the store + +| Endpoint | Function | Required role | +| --- | --- | --- | +| [`PATCH /{id}`](/en/release-management-api/apps/api-reference/update-app) | Update app settings, including store connection. | Release manager | + +If you added an app with `manual_connection: true` or need to update the store credentials, use `PATCH /{id}`: + +```bash +curl -X PATCH "https://api.bitrise.io/release-management/v2/apps/v1/APP_ID" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "connect_to_store": true, + "store_credential_id": YOUR_CREDENTIAL_ID + }' +``` + +You can also update the `store_app_id` via `PATCH /{id}` if the app was initially registered with an incorrect identifier. + +## Listing apps + +To list all apps in a workspace: + +```bash +curl -X GET "https://api.bitrise.io/release-management/v2/apps/v1/?workspace_slug=YOUR_WORKSPACE_SLUG" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Accept: application/json" +``` + +Optional query parameters: + +- `platform`: Filter by `ios` or `android`. +- `project_id`: Filter by an associated Bitrise CI project ID. +- `search`: Search by app name. +- `items_per_page`: Results per page (default: 10, max: 50). +- `page`: Page number (default: 1). + +## Removing an app + +:::warning[Deletion is permanent] + +Removing an app from Release Management deletes all associated releases, artifacts, and configuration. This cannot be undone. + +::: + +```bash +curl -X DELETE "https://api.bitrise.io/release-management/v2/apps/v1/APP_ID" \ + -H "Authorization: YOUR_ACCESS_TOKEN" +``` diff --git a/docs/release-management/api/build-distribution.mdx b/docs/release-management/api/build-distribution.mdx new file mode 100644 index 00000000..b06e5701 --- /dev/null +++ b/docs/release-management/api/build-distribution.mdx @@ -0,0 +1,255 @@ +--- +title: "Distributing builds to testers" +description: "Upload build artifacts and distribute them to tester groups via the Release Management API." +sidebar_position: 5 +slug: /release-management/api/build-distribution +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +You can upload build artifacts to Release Management and distribute them to tester groups directly via the API. Tester groups can be internal (Bitrise users you add by their user slug) or external (testers you add by email, with no Bitrise account required). This covers both the artifact upload flow (Apps sub-API) and tester group management (Build Distributions sub-API). + +- **Apps sub-API base URL:** `https://api.bitrise.io/release-management/v2/apps/v1`. See the [Apps API reference](/en/release-management-api/apps/api-reference/release-management-api). +- **Build Distributions sub-API base URL:** `https://api.bitrise.io/release-management/v2/build-distributions/v1`. See the [Build Distributions API reference](/en/release-management-api/build-distributions/api-reference/release-management-api-build-distributions). + +## Uploading a build artifact + +| Endpoint | Sub-API | Function | +| --- | --- | --- | +| [`GET /installable-artifacts/{id}/upload-url`](/en/release-management-api/apps/api-reference/generate-installable-artifact-upload-url) | Apps | Generate a presigned upload URL. | +| [`GET /installable-artifacts/{id}/status`](/en/release-management-api/apps/api-reference/get-installable-artifact-status) | Apps | Check upload and processing status. | +| [`GET /installable-artifacts`](/en/release-management-api/apps/api-reference/list-installable-artifacts) | Apps | List uploaded artifacts for an app. | +| [`GET /installable-artifacts/{id}`](/en/release-management-api/apps/api-reference/get-installable-artifact) | Apps | Get details of an artifact. | +| [`DELETE /installable-artifacts/{id}`](/en/release-management-api/apps/api-reference/delete-installable-artifact) | Apps | Delete an artifact. | + +### Step 1: Generate an upload URL + +Generate a presigned S3 upload URL for your build artifact. The response includes both the upload URL and confirms the artifact ID. + +```bash +ARTIFACT_ID=$(uuidgen | tr '[:upper:]' '[:lower:]') + +curl -X GET "https://api.bitrise.io/release-management/v2/apps/v1/installable-artifacts/${ARTIFACT_ID}/upload-url?app_id=APP_ID&file_name=MyApp.ipa&file_size_bytes=52428800" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Accept: application/json" +``` + +Required query parameters: +- `app_id`: The RM app ID. +- `file_name`: The filename of the artifact (e.g., `MyApp.ipa` or `MyApp.apk`). +- `file_size_bytes`: The file size in bytes. + +Optional query parameters: +- `with_public_page`: Set to `true` to enable a public install page immediately. +- `branch`: The source branch this build came from. +- `workflow`: The CI workflow that produced this build. + +### Step 2: Upload the binary + +You can upload `.ipa` (iOS), `.apk`, or `.aab` (Android) files. Use the `method`, `url`, and `headers` from the previous response exactly as returned — the headers vary per upload and typically include `Content-Type` and `X-Goog-Content-Length-Range`: + +```bash +# Use the method, url, and headers exactly as returned by the Step 1 response. + +curl -X PUT "PRESIGNED_UPLOAD_URL" \ + -H "Content-Type: " \ + -H "X-Goog-Content-Length-Range: " \ + --data-binary "@/path/to/MyApp.aab" +``` + +### Step 3: Check processing status + +After upload, wait for Bitrise to finish processing the artifact: + +```bash +curl -X GET "https://api.bitrise.io/release-management/v2/apps/v1/installable-artifacts/${ARTIFACT_ID}/status" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Accept: application/json" +``` + +The response returns the current `status`. Poll this endpoint until the status indicates the artifact is ready for distribution. + +## Listing installable artifacts + +To act on an artifact you didn't just upload yourself, look it up with [`GET /installable-artifacts`](/en/release-management-api/apps/api-reference/list-installable-artifacts): + +```bash +curl -X GET "https://api.bitrise.io/release-management/v2/apps/v1/installable-artifacts?app_id=APP_ID&items_per_page=10&page=1" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Accept: application/json" +``` + +:::note[Use `uid`, not `id`] + +Each item in the response includes both an `id` and a `uid` field. Use `uid` as the `ARTIFACT_ID` in other calls — `id` is a separate identifier and won't work in the endpoints on this page. + +::: + +## Enabling a public install page + +You can make a build available via a public URL that testers can open directly without a Bitrise account. + +```bash +curl -X PATCH "https://api.bitrise.io/release-management/v2/apps/v1/installable-artifacts/ARTIFACT_ID/public-install-page" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "with_public_page": true + }' +``` + +## Adding what-to-test notes + +Attach test instructions to a build that testers can see when they receive the notification. + +```bash +curl -X PATCH "https://api.bitrise.io/release-management/v2/apps/v1/installable-artifacts/ARTIFACT_ID/what-to-test" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "what_to_test": "Focus on the new onboarding flow. Check that the splash screen animation completes before login." + }' +``` + +The `what_to_test` field accepts up to 4,000 characters. + +## Creating custom access links + +Custom access links let you share a build with restricted access: optionally protected by a code and with an expiry date. For more information, see [Custom access links](/en/release-management/build-distribution/distributing-builds-to-testers#custom-access-link). + +:::note + +A custom access link is different from the [public install page](/en/bitrise-ci/deploying/ios-deployment/installing-an-ipa-file-from-the-public-install-page) link: the public install page is permanent and has no access controls. + +::: + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/apps/v1/installable-artifacts/ARTIFACT_ID/custom-access-links" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "name": "External QA team", + "expires_at": "2026-07-31T23:59:59Z", + "access_code": "qa-team-2026" + }' +``` + +The `access_code` must be 8–64 characters. Omit `expires_at` to create a link that does not expire. + +## Managing tester groups + +Tester groups let you notify groups of internal testers when a new build is ready. For more information, see [Tester groups](/en/release-management/build-distribution/tester-groups). + +| Endpoint | Function | +| --- | --- | +| [`POST /tester-groups`](/en/release-management-api/build-distributions/api-reference/create-tester-group) | Create a tester group. | +| [`GET /tester-groups`](/en/release-management-api/build-distributions/api-reference/list-tester-groups) | List tester groups for an app. | +| [`PUT /tester-groups/{id}`](/en/release-management-api/build-distributions/api-reference/update-tester-group) | Update a tester group. | +| [`POST /tester-groups/{id}/add-testers`](/en/release-management-api/build-distributions/api-reference/add-testers-to-tester-group) | Add testers to a group. | +| [`POST /tester-groups/{id}/notify`](/en/release-management-api/build-distributions/api-reference/notify-tester-group) | Notify a group about a new build. | +| [`DELETE /tester-groups/{id}`](/en/release-management-api/build-distributions/api-reference/delete-tester-group) | Delete a tester group. | + +### Creating a tester group + +Set the `type` query parameter to choose between an internal group (Bitrise users, added by user slug) or an external group (testers added by email, no Bitrise account required). `type` defaults to `internal` when omitted. + + + + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/build-distributions/v1/tester-groups" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "app_id": "APP_ID", + "name": "iOS Beta Testers", + "auto_notify": true + }' +``` + + + + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/build-distributions/v1/tester-groups?type=external" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "app_id": "APP_ID", + "name": "External QA testers", + "auto_notify": true, + "emails": ["tester1@example.com", "tester2@example.com"] + }' +``` + +The `emails` array accepts up to 1,000 addresses (each up to 255 characters) and is ignored for internal groups. A tester is created for every address and added to the group. + + + + +Setting `auto_notify: true` means testers are automatically emailed when a new build is uploaded. + +### Adding testers to a group + +Set the `type` query parameter to match the group's type — `type` defaults to `internal` when omitted. The array that doesn't match the group's type is ignored. + + + + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/build-distributions/v1/tester-groups/GROUP_ID/add-testers" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "user_slugs": ["USER_SLUG_1", "USER_SLUG_2"] + }' +``` + +:::tip[Finding user slugs] + +To find the user slugs of workspace members, use `GET /tester-groups/{id}/potential-testers?search=name-or-email` to search for eligible testers. The response includes each user's `slug`. + +::: + + + + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/build-distributions/v1/tester-groups/GROUP_ID/add-testers?type=external" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "emails": ["tester1@example.com", "tester2@example.com"] + }' +``` + +The `emails` array accepts up to 1,000 addresses. A tester is created or reused for each address. + + + + +### Notifying a tester group + +Send a notification to a tester group about a specific build: + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/build-distributions/v1/tester-groups/GROUP_ID/notify" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "test_build_id": "ARTIFACT_ID" + }' +``` + +The build must be distribution-ready before you can notify testers. A successful call returns `204 No Content`. + +## Listing uploaded builds + +To list all builds available for distribution for a specific version: + +```bash +curl -X GET "https://api.bitrise.io/release-management/v2/build-distributions/v1/test-builds?app_id=APP_ID&version=1.5.0" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Accept: application/json" +``` diff --git a/docs/release-management/api/creating-an-app-version.mdx b/docs/release-management/api/creating-an-app-version.mdx new file mode 100644 index 00000000..d34e9d8f --- /dev/null +++ b/docs/release-management/api/creating-an-app-version.mdx @@ -0,0 +1,194 @@ +--- +title: "Creating an app version" +description: "Create and configure an app version for your app via the Release Management API." +sidebar_position: 3 +slug: /release-management/api/creating-an-app-version +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +An app version moves through the release process — from the release candidate stage through approvals, store submission, and production release. + +The Store Releases sub-API base URL: `https://api.bitrise.io/release-management/v2/store-releases/v1`. See the [Store Releases API reference](/en/release-management-api/store-releases/api-reference/release-management-api-app-versions) for the full list of endpoints, parameters, and schemas. + +## Creating an app version + +| Endpoint | Function | Required role | +| --- | --- | --- | +| [`POST /app-versions`](/en/release-management-api/store-releases/api-reference/create-release) | Create a new app version. | Release manager | +| [`GET /app-versions`](/en/release-management-api/store-releases/api-reference/list-releases) | List app versions for an app. | Any | +| [`GET /app-versions/{id}`](/en/release-management-api/store-releases/api-reference/get-release) | Get details of an app version. | Any | +| [`PATCH /app-versions/{id}`](/en/release-management-api/store-releases/api-reference/update-release) | Update an app version. | Release manager | +| [`DELETE /app-versions/{id}`](/en/release-management-api/store-releases/api-reference/delete-release) | Delete an app version. | Release manager | + +To create an app version: + +1. Call `POST /app-versions` with the required fields: + + - `name`: The version name for this app version. + - `app_id`: The ID of the app in Release Management (returned when you [added the app](/en/release-management/api/adding-and-connecting-an-app)). + + :::note[Version format for iOS] + + For iOS apps, `name` is used as the App Store Connect version string and must follow the `X.Y.Z` format (e.g., `1.2.0`). + + ::: + + ```bash + curl -X POST "https://api.bitrise.io/release-management/v2/store-releases/v1/app-versions" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "name": "1.5.0", + "app_id": "APP_ID", + "description": "Spring feature release", + "artifact_source": "ci" + }' + ``` + + The response includes the app version's `id`, which you'll use in subsequent calls. + + ```json + { + "id": "YOUR_APP_VERSION_ID", + "name": "1.5.0", + "status": "scheduled", + "description": "Spring feature release", + "connected_app_id": "YOUR_APP_ID", + "artifact_source": "ci", + "platform": "android", + "store_app_id": "com.example.myapp", + "created_at": "2026-01-01T00:00:00.000Z", + "released_at": null, + "release_candidate_id": null, + "stages": [ + { "name": "release-candidate", "status": "pending" }, + { "name": "approvals", "status": "pending" }, + { "name": "app-store-review", "status": "pending" }, + { "name": "release", "status": "pending" } + ] + } + ``` + +## Configuring release automation + +You can define automation rules that trigger CI builds automatically when an app version reaches a certain stage. For a full overview of how automation works, see [Release automation](/en/release-management/releases/configuring-a-release/release-automation). + +Set the `automation` field when creating or updating an app version: + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/store-releases/v1/app-versions" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "name": "1.5.0", + "app_id": "APP_ID", + "artifact_source": "ci", + "release_branch": "release/1.5.0", + "workflow": "release", + "automation": [ + { + "event_name": "release_candidate_set", + "workflow_name": "run-tests" + }, + { + "event_name": "approvals_completed", + "workflow_name": "upload-to-store" + } + ] + }' +``` + +Available automation `event_name` values depend on the platform. For the full, up-to-date list and what triggers each event, see [Automation events](/en/release-management/releases/configuring-a-release/release-automation#automation-events). + + + + +- `release_candidate_set`: A new release candidate is selected. +- `testflight_upload_finished`: TestFlight processing finishes for an uploaded build. +- `beta_review_approved`: Apple approves the beta app review. +- `beta_review_rejected`: Apple rejects the beta app review. +- `release_for_apple_app_store_testing_group`: The build is released to a TestFlight testing group. +- `approvals_completed`: All approval tasks are marked complete. +- `submitted_for_review`: The app version is submitted for App Store review. +- `review_status_changed` / `review_cancelled`: The review submission status changes. +- `release_started`: The rollout to the App Store starts. +- `release_completed`: The app version is fully rolled out. + + + + +- `release_candidate_set`: A new release candidate is selected. +- `google_play_store_upload_finished`: The build finishes uploading to the Google Play console. +- `release_on_google_play_store_testing_track`: The release candidate is released on a Google Play testing track. +- `approvals_completed`: All approval tasks are marked complete. +- `release_started`: The rollout starts (full release or the first stage of a staged rollout). +- `release_completed`: The app version is fully rolled out. +- `release_percentage_changed`: The staged rollout percentage changes (not triggered on the first rollout). + + + + +## Adding approval tasks to an app version + +| Endpoint | Function | Required role | +| --- | --- | --- | +| [`POST /app-versions/{id}/approvals`](/en/release-management-api/store-releases/api-reference/create-approval-task) | Create an approval task. | Release manager | +| [`GET /app-versions/{id}/approvals`](/en/release-management-api/store-releases/api-reference/list-approval-tasks) | List approval tasks. | Any | +| [`PATCH /app-versions/{id}/approvals/{task_id}`](/en/release-management-api/store-releases/api-reference/update-approval-task) | Update or complete an approval task. | Assigned user | + +You can create approval tasks that team members must complete before the app version proceeds. + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/store-releases/v1/app-versions/APP_VERSION_ID/approvals" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "summary": "QA sign-off", + "description": "Verify all test cases pass on the release build", + "assigned_user_slug": "USER_SLUG", + "due_date": "2026-07-10" + }' +``` + +To mark an approval task as complete: + +```bash +curl -X PATCH "https://api.bitrise.io/release-management/v2/store-releases/v1/app-versions/APP_VERSION_ID/approvals/TASK_ID" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "completed": true + }' +``` + +## Applying a preset to an app version + +If you have [release presets](/en/release-management/api/creating-presets) configured, apply one when creating the app version to inherit its automation, approvals, and notification settings: + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/store-releases/v1/app-versions" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "name": "1.5.0", + "app_id": "APP_ID", + "presets_id": "PRESET_ID" + }' +``` + +## Deleting an app version + +:::warning[Deletion is permanent] + +Deleting an app version removes it and all associated data. This cannot be undone. + +::: + +```bash +curl -X DELETE "https://api.bitrise.io/release-management/v2/store-releases/v1/app-versions/APP_VERSION_ID" \ + -H "Authorization: YOUR_ACCESS_TOKEN" +``` + +A successful response returns `204 No Content` with an empty body. diff --git a/docs/release-management/api/creating-presets.mdx b/docs/release-management/api/creating-presets.mdx new file mode 100644 index 00000000..12334f8e --- /dev/null +++ b/docs/release-management/api/creating-presets.mdx @@ -0,0 +1,173 @@ +--- +title: "Creating and managing presets" +description: "Create reusable release configuration templates (presets) via the Release Management API." +sidebar_position: 4 +slug: /release-management/api/creating-presets +--- + +Presets are reusable release configuration templates. They let you define automation rules, approval tasks, notifications, and CI build settings once and apply them consistently across multiple releases. + +The Apps sub-API base URL: `https://api.bitrise.io/release-management/v2/apps/v1`. See the [Apps API reference](/en/release-management-api/apps/api-reference/release-management-api) for the full list of endpoints, parameters, and schemas. + +## Creating a preset + +| Endpoint | Function | Required role | +| --- | --- | --- | +| [`POST /presets`](/en/release-management-api/apps/api-reference/create-preset) | Create a new preset. | Release manager | +| [`GET /presets`](/en/release-management-api/apps/api-reference/get-presets-list) | List presets for an app. | Any | +| [`GET /presets/{id}`](/en/release-management-api/apps/api-reference/get-presets) | Get a specific preset. | Any | +| [`PUT /presets/{id}`](/en/release-management-api/apps/api-reference/update-presets) | Update a preset. | Release manager | +| [`DELETE /presets/{id}`](/en/release-management-api/apps/api-reference/delete-preset) | Delete a preset. | Release manager | + +To create a preset, call `POST /presets` with at least a name and the app it belongs to. + +Required fields: +- `app_id`: The ID of the app in Release Management. +- `template_name`: A descriptive name for the preset. + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/apps/v1/presets" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "app_id": "APP_ID", + "template_name": "Standard release" + }' +``` + +## Creating a preset with full configuration + +A preset can bundle automation rules, approval tasks, Slack notifications, and upload settings into a single reusable template. + +### Automation + +Automation rules trigger a CI workflow when a release reaches a specific stage. Set the `automation` field to an array of event/workflow pairs: + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/apps/v1/presets" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "app_id": "APP_ID", + "template_name": "Standard release", + "automation": [ + { + "event_name": "release_candidate_set", + "workflow_name": "run-tests" + }, + { + "event_name": "approvals_completed", + "workflow_name": "upload-to-store" + } + ] + }' +``` + +### Approval tasks + +Approval tasks are created automatically for every release that uses this preset. Set the `approvals` field to define the tasks: + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/apps/v1/presets" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "app_id": "APP_ID", + "template_name": "Standard release", + "approvals": [ + { + "summary": "QA sign-off", + "description": "Verify all test cases pass on the release build" + } + ] + }' +``` + +### Slack notifications + +To send Slack notifications at key release stages, pass the ID of a configured Slack integration in the `notifications` field. For more information, see [Slack integration](/en/bitrise-platform/workspaces/workspace-slack-integration). + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/apps/v1/presets" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "app_id": "APP_ID", + "template_name": "Standard release", + "notifications": { + "slack_notification_integration_id": "YOUR_SLACK_INTEGRATION_ID" + } + }' +``` + +### Automatic store upload + +Set `auto_upload: true` to automatically upload the build to the store once it's ready, without a manual trigger: + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/apps/v1/presets" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "app_id": "APP_ID", + "template_name": "Standard release", + "auto_upload": true + }' +``` + +You can combine any of these settings in a single request. Save the `id` from the response — you'll use it when [creating app versions](/en/release-management/api/creating-an-app-version#applying-a-preset-to-an-app-version). + +:::note[Default preset] + +Setting `default: true` marks this preset as the one automatically applied to new releases. Only one preset per app can be the default. + +::: + +## Listing presets for an app + +```bash +curl -X GET "https://api.bitrise.io/release-management/v2/apps/v1/presets?app_id=APP_ID" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Accept: application/json" +``` + +## Updating a preset + +Use `PUT /presets/{id}` to replace the preset's configuration. All fields are optional. + +```bash +curl -X PUT "https://api.bitrise.io/release-management/v2/apps/v1/presets/PRESET_ID" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "default": true, + "auto_upload": false, + "automation": [ + { + "event_name": "release_candidate_set", + "workflow_name": "run-extended-tests" + } + ], + "approvals": [ + { + "summary": "QA sign-off" + }, + { + "summary": "Security review" + } + ] + }' +``` + +## Deleting a preset + +```bash +curl -X DELETE "https://api.bitrise.io/release-management/v2/apps/v1/presets/PRESET_ID" \ + -H "Authorization: YOUR_ACCESS_TOKEN" +``` + +:::important[Existing releases not affected] + +Deleting a preset does not affect releases that were created using it. The settings are copied to the release at creation time. + +::: diff --git a/docs/release-management/release-management-api.mdx b/docs/release-management/api/release-management-api.mdx similarity index 84% rename from docs/release-management/release-management-api.mdx rename to docs/release-management/api/release-management-api.mdx index 8d384938..b37aead0 100644 --- a/docs/release-management/release-management-api.mdx +++ b/docs/release-management/api/release-management-api.mdx @@ -1,10 +1,8 @@ --- -title: "Release Management API" +title: "Overview" description: "Bitrise offers a REST API for Release Management: you can connect apps, configure presets, manage your releases, and distribute the apps via the API." -sidebar_position: 7 -slug: /release-management/release-management-api -sidebar_custom_props: - icon: Code +sidebar_position: 1 +slug: /release-management/api/release-management-api --- import Tabs from '@theme/Tabs'; @@ -16,14 +14,14 @@ Bitrise offers a REST API for Release Management. The base URL for the API is . The API is available in two versions: - v1: https://api.bitrise.io/release-management/v1. This is deprecated. -- v2: The current version. It has domain-specific sub APIs, with the URLs described here: [Sub APIs](/en/release-management/release-management-api#sub-apis). +- v2: The current version. It has domain-specific sub APIs, with the URLs described here: [Sub APIs](/en/release-management/api/release-management-api#sub-apis). -The API offers the same features that are available on the GUI. You can:. +The API offers the same features that are available on the GUI: -- Connect apps. -- Configure presets. -- Manage releases in all stages, including the release candidate stage and the approval stage. -- Distribute your apps. +- Manage apps: create presets, connect an app to the App Store or Google Play, manage artifacts, and configure webhooks. +- Create store releases: manage an app version through every stage of the release process, from selecting a release candidate to releasing it to the store. +- Use CodePush: deploy over-the-air updates to React Native apps. +- Distribute builds: distribute your app to testers over the air. ## Sub APIs diff --git a/docs/release-management/api/releasing-an-app.mdx b/docs/release-management/api/releasing-an-app.mdx new file mode 100644 index 00000000..4f0c20aa --- /dev/null +++ b/docs/release-management/api/releasing-an-app.mdx @@ -0,0 +1,253 @@ +--- +title: "Releasing an app to the store" +description: "Submit your app for review and release it to the App Store or Google Play via the Release Management API." +sidebar_position: 6 +slug: /release-management/api/releasing-an-app +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Once your release has a release candidate uploaded to the store and all approvals are completed, you can release it to users. For iOS, this also requires submitting the app for App Store review first. Android releases skip straight to the release step. + +The Store Releases sub-API base URL: `https://api.bitrise.io/release-management/v2/store-releases/v1`. See the [Store Releases API reference](/en/release-management-api/store-releases/api-reference/release-management-api-app-versions) for the full list of endpoints, parameters, and schemas. + +## Configuring beta distribution (iOS) + +Before submitting for full release, you can distribute the build to beta testers through TestFlight (iOS only). + +### Listing TestFlight testing groups + +Returns the TestFlight testing groups associated with the release. Use the `id` values from the response to start distribution to a specific group. + +```bash +curl -X GET "https://api.bitrise.io/release-management/v2/store-releases/v1/app-versions/RELEASE_ID/beta-distribution/testing-groups" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Accept: application/json" +``` + +### Starting beta distribution to a TestFlight group + +Makes the release build available to testers in a specific TestFlight group. Testers receive a notification and can install the build directly from the TestFlight app. + +```bash +curl -X PATCH "https://api.bitrise.io/release-management/v2/store-releases/v1/app-versions/RELEASE_ID/beta-distribution/testing-groups/GROUP_ID" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" +``` + +### Adding what-to-test notes for TestFlight + +Attaches testing instructions to the release build. Testers see these notes in the TestFlight app when they receive the build notification. + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/store-releases/v1/app-versions/RELEASE_ID/beta-distribution/what-to-test" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "locale": "en-US", + "whats_new": "Fixed login issue and improved onboarding flow." + }' +``` + +## Adding release notes (Android) + +Release notes appear on the app's Google Play Store listing under **What's new**, and are shown to users before and after they update the app. You can provide notes in multiple languages — Google Play displays the version that matches the user's device language, falling back to `en-US` if no match is found. + +Pass an array of language/text pairs to the `release_notes` field, using [BCP 47 language tags](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) (e.g. `en-US`, `de-DE`, `fr-FR`): + +```bash +curl -X PUT "https://api.bitrise.io/release-management/v2/store-releases/v1/app-versions/RELEASE_ID/google-play-store/localized-release-notes" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "release_notes": [ + { + "language": "en-US", + "text": "Fixed login issue and improved onboarding flow." + }, + { + "language": "de-DE", + "text": "Login-Problem behoben und Onboarding-Flow verbessert." + } + ] + }' +``` + +Each release note text can be up to 500 characters. + +## Submitting for store review (iOS) + +:::note[Android] + +Android releases submitted via the API go directly to the configured Google Play track and do not require a separate review submission step. Proceed to the release step below. + +::: + +| Endpoint | Function | Required role | +| --- | --- | --- | +| [`POST /app-versions/{id}/apple-app-store/review/submit`](/en/release-management-api/store-releases/api-reference/submit-release-candidate-for-review) | Submit the release for App Store review. | Release manager | +| [`GET /app-versions/{id}/apple-app-store/review/status`](/en/release-management-api/store-releases/api-reference/get-review-status) | Get the current App Store review status. | Any | +| [`POST /app-versions/{id}/apple-app-store/review/cancel`](/en/release-management-api/store-releases/api-reference/cancel-review) | Cancel a pending review submission. | Release manager | + +Submit the release for App Store review: + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/store-releases/v1/app-versions/RELEASE_ID/apple-app-store/review/submit" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "copy_primary_whats_new": true, + "localizations": [ + { + "locale": "en-US", + "whats_new": "Bug fixes and performance improvements.", + "description": "Updated description for this version.", + "keywords": "productivity, task manager" + } + ] + }' +``` + +Setting `copy_primary_whats_new: true` copies the primary locale's "What's new" text to all other localizations that have no text set. + +To check the review status: + +```bash +curl -X GET "https://api.bitrise.io/release-management/v2/store-releases/v1/app-versions/RELEASE_ID/apple-app-store/review/status" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Accept: application/json" +``` + +## Configuring release settings + + + + +Before releasing, configure how the update rolls out to users: + +```bash +curl -X PATCH "https://api.bitrise.io/release-management/v2/store-releases/v1/app-versions/RELEASE_ID/apple-app-store/release/settings" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "release_type": "AFTER_APPROVAL", + "phased_release": true + }' +``` + +`release_type` options: +- `AFTER_APPROVAL`: Release automatically once approved by Apple. +- `MANUAL`: Hold the release until you manually trigger it. +- `SCHEDULED`: Release at a specific date and time (requires `earliest_release_date` in ISO 8601 format). + +`phased_release: true` rolls the update out to users over 7 days rather than all at once. + + + + +For Android you can schedule the rollout to a fraction of users (staged rollout): + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/store-releases/v1/app-versions/RELEASE_ID/google-play-store/staged-rollout-schedule" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "location": "America/New_York", + "schedule": [ + { "percentage": 10, "when": "2026-07-20T09:00:00-04:00" }, + { "percentage": 50, "when": "2026-07-22T09:00:00-04:00" }, + { "percentage": 100, "when": "2026-07-25T09:00:00-04:00" } + ] + }' +``` + + + + +## Releasing to users + + + + +| Endpoint | Function | Required role | +| --- | --- | --- | +| [`POST /app-versions/{id}/apple-app-store/release`](/en/release-management-api/store-releases/api-reference/create-store-release-ios) | Release the app to the App Store. | Release manager | +| [`GET /app-versions/{id}/apple-app-store/release/status`](/en/release-management-api/store-releases/api-reference/get-release-status) | Get the release status. | Any | +| [`POST /app-versions/{id}/apple-app-store/release/pause`](/en/release-management-api/store-releases/api-reference/pause-phased-release-ios) | Pause a phased release. | Release manager | +| [`POST /app-versions/{id}/apple-app-store/release/continue`](/en/release-management-api/store-releases/api-reference/continue-phased-release-ios) | Continue a paused phased release. | Release manager | +| [`POST /app-versions/{id}/apple-app-store/release/complete`](/en/release-management-api/store-releases/api-reference/complete-phased-release-ios) | Complete a phased release immediately. | Release manager | + +Trigger the release: + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/store-releases/v1/app-versions/RELEASE_ID/apple-app-store/release" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" +``` + +Check the release status: + +```bash +curl -X GET "https://api.bitrise.io/release-management/v2/store-releases/v1/app-versions/RELEASE_ID/apple-app-store/release/status" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Accept: application/json" +``` + +To complete a phased release immediately (rolling out to 100% of users right away): + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/store-releases/v1/app-versions/RELEASE_ID/apple-app-store/release/complete" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" +``` + + + + +| Endpoint | Function | Required role | +| --- | --- | --- | +| [`POST /app-versions/{id}/google-play-store/release`](/en/release-management-api/store-releases/api-reference/create-store-release-android) | Release to all or a fraction of users. | Release manager | + +Release to all users: + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/store-releases/v1/app-versions/RELEASE_ID/google-play-store/release" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "user_fraction": 1.0 + }' +``` + +For a staged rollout starting at 10%: + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/store-releases/v1/app-versions/RELEASE_ID/google-play-store/release" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "user_fraction": 0.1 + }' +``` + +The `user_fraction` value ranges from `0` to `1`, where `1` equals 100% of users. + + + + +## Setting up release webhooks + +You can configure outgoing webhooks to receive notifications when a release reaches key stages. + +```bash +curl -X POST "https://api.bitrise.io/release-management/v2/store-releases/v1/app-versions/RELEASE_ID/outgoing-webhooks" \ + -H "Authorization: YOUR_ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "events": ["release_started", "submitted_for_review"], + "webhook_configuration_id": "WEBHOOK_CONFIG_ID" + }' +``` + +Set `all_events: true` instead of listing individual events to receive notifications for all release lifecycle events. diff --git a/docs/release-management/codepush/creating-a-codepush-deployment.mdx b/docs/release-management/codepush/creating-a-codepush-deployment.mdx index d0a1b788..5e6abb95 100644 --- a/docs/release-management/codepush/creating-a-codepush-deployment.mdx +++ b/docs/release-management/codepush/creating-a-codepush-deployment.mdx @@ -12,7 +12,7 @@ import Partial_ReleaseManagementConfiguration from '@site/src/partials/release-m Create a CodePush deployment to get your deployment key. You need the deployment key to release CodePush updates to your apps. -You can create a deployment either via the [API](/en/release-management/release-management-api) or on the Release Management GUI. +You can create a deployment either via the [API](/en/release-management/api/release-management-api) or on the Release Management GUI. @@ -33,7 +33,7 @@ You can create a deployment either via the [API](/en/release-management/release- 1. Make sure you have a [personal access token](/en/bitrise-platform/accounts/personal-access-tokens#creating-a-personal-access-token) or a [workspace API token](/en/bitrise-platform/workspaces/workspace-api-token#creating-a-workspace-api-token). - A token is required for authorization with the [Release Management API](/en/release-management/release-management-api). + A token is required for authorization with the [Release Management API](/en/release-management/api/release-management-api). 1. For each React Native project, make sure you have [two apps](/en/release-management/getting-started-with-release-management/adding-a-new-app-to-release-management) in Release Management: one for iOS, one for Android. 1. Get the app ID for each app. You can see it in the URL of the app page: https://app.bitrise.io/release-management/workspaces//connected-apps/. diff --git a/docs/release-management/index.mdx b/docs/release-management/index.mdx index 9a55c53e..b385d5b7 100644 --- a/docs/release-management/index.mdx +++ b/docs/release-management/index.mdx @@ -71,8 +71,8 @@ import ProductOverview from '@site/src/components/ProductOverview'; description: 'After connecting an app, you can add a new version and release it to the App Store or Google Play.', }, { - label: 'Release Management API', - href: '/en/release-management/release-management-api', + label: 'API guides', + href: '/en/release-management/api/release-management-api', description: 'Bitrise provides a REST API for Release Management, which offers the same features as the GUI.', }, ], diff --git a/docs/release-management/releases/managing-the-release-process/creating-tasks-for-the-approvals-stage.md b/docs/release-management/releases/managing-the-release-process/creating-tasks-for-the-approvals-stage.md index fcba013c..7ef4927c 100644 --- a/docs/release-management/releases/managing-the-release-process/creating-tasks-for-the-approvals-stage.md +++ b/docs/release-management/releases/managing-the-release-process/creating-tasks-for-the-approvals-stage.md @@ -36,7 +36,7 @@ When done, you can proceed to: ## Assigning an approval task to a team member with the REST API -You can assign an approval task to a team member with the help of our [Release Management API](/en/release-management/release-management-api). For more information on our API endpoint, check out our [API docs](https://api-docs.bitrise.io/). +You can assign an approval task to a team member with the help of our [Release Management API](/en/release-management/api/release-management-api). For more information on our API endpoint, check out our [API docs](https://api-docs.bitrise.io/). :::note[Limited access] diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 49b19ffe..5a617da1 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -315,6 +315,39 @@ const config: Config = { groupPathsBy: 'tag', }, }, + // Release Management is split across four sub-APIs, each with its + // own hosted spec (see docs/release-management/api/release-management-api.mdx + // for the sub-API URLs). Snapshots are refreshed by the matching + // scripts/sync_rm_*.py scripts (nightly / on-demand by + // .github/workflows/sync-api-references.yml). + bitriseRMApps: { + specPath: 'api/bitrise-rm-apps.json', + outputDir: 'docs/release-management-api/apps/api-reference', + sidebarOptions: { + groupPathsBy: 'tag', + }, + }, + bitriseRMStoreReleases: { + specPath: 'api/bitrise-rm-store-releases.json', + outputDir: 'docs/release-management-api/store-releases/api-reference', + sidebarOptions: { + groupPathsBy: 'tag', + }, + }, + bitriseRMCodePush: { + specPath: 'api/bitrise-rm-code-push.json', + outputDir: 'docs/release-management-api/code-push/api-reference', + sidebarOptions: { + groupPathsBy: 'tag', + }, + }, + bitriseRMBuildDistributions: { + specPath: 'api/bitrise-rm-build-distributions.json', + outputDir: 'docs/release-management-api/build-distributions/api-reference', + sidebarOptions: { + groupPathsBy: 'tag', + }, + }, }, }, ], diff --git a/package-lock.json b/package-lock.json index c95d1cef..1f6a1a07 100644 --- a/package-lock.json +++ b/package-lock.json @@ -172,6 +172,7 @@ "resolved": "https://registry.npmjs.org/@algolia/client-search/-/client-search-5.52.1.tgz", "integrity": "sha512-gA8oJOV1LnQQkDf91iebNnFInHuW0gRPEgLSOQ7EfipCEjYTHm5swm1DlH9H5RaRw4RrHuzHBegnlzc0MAstcg==", "license": "MIT", + "peer": true, "dependencies": { "@algolia/client-common": "5.52.1", "@algolia/requester-browser-xhr": "5.52.1", @@ -413,6 +414,7 @@ "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.29.0.tgz", "integrity": "sha512-CGOfOJqWjg2qW/Mb6zNsDm+u5vFQ8DxXfbM09z69p5Z6+mE1ikP2jUXw+j42Pf1XTYED2Rni5f95npYeuwMDQA==", "license": "MIT", + "peer": true, "dependencies": { "@babel/code-frame": "^7.29.0", "@babel/generator": "^7.29.0", @@ -2288,6 +2290,7 @@ "resolved": "https://registry.npmjs.org/@chakra-ui/react/-/react-3.35.0.tgz", "integrity": "sha512-qzfRNLwxKjxx2IXjBj6uz1nYI+pKsq6uwHxO619+hx1OzNNuwLIjEHJxnDfBzoynO7sPCBlubMwFWb1e1PrXzw==", "license": "MIT", + "peer": true, "dependencies": { "@ark-ui/react": "5.36.2", "@emotion/is-prop-valid": "^1.4.0", @@ -2441,6 +2444,7 @@ } ], "license": "MIT", + "peer": true, "engines": { "node": ">=18" }, @@ -2463,6 +2467,7 @@ } ], "license": "MIT", + "peer": true, "engines": { "node": ">=18" } @@ -2572,6 +2577,7 @@ "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", "license": "MIT", + "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -2993,6 +2999,7 @@ "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", "license": "MIT", + "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -3823,6 +3830,7 @@ "resolved": "https://registry.npmjs.org/@docusaurus/core/-/core-3.10.1.tgz", "integrity": "sha512-3pf2fXXw0eVk8WnC3T4LIigRDupcpvngpKo9Vy7mYyBhuddc0klDUuZAIfzMoK6z05pdlk6EFC/vBSX43+1O5w==", "license": "MIT", + "peer": true, "dependencies": { "@docusaurus/babel": "3.10.1", "@docusaurus/bundler": "3.10.1", @@ -4011,6 +4019,7 @@ "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.10.1.tgz", "integrity": "sha512-2jRVrtzjf8LClGTHQlwlwuD3wQXRx3WEoF7XUarJ8Ou+0onV+SLtejsyfY9JLpfUh9hPhXM4pbBGkyAY4Bi3HQ==", "license": "MIT", + "peer": true, "dependencies": { "@docusaurus/core": "3.10.1", "@docusaurus/logger": "3.10.1", @@ -4239,6 +4248,7 @@ "resolved": "https://registry.npmjs.org/@docusaurus/theme-classic/-/theme-classic-3.10.1.tgz", "integrity": "sha512-VU1RK0qb2pab0si4r7HFK37cYco8VzqLj3u1PspVipSr/z/GPVKHO4/HXbnePqHoWDk8urjyGSeatH0NIMBM1A==", "license": "MIT", + "peer": true, "dependencies": { "@docusaurus/core": "3.10.1", "@docusaurus/logger": "3.10.1", @@ -4280,6 +4290,7 @@ "resolved": "https://registry.npmjs.org/@docusaurus/theme-common/-/theme-common-3.10.1.tgz", "integrity": "sha512-0YtmIeoNo1fIw65LO8+/1dPgmDV86UmhMkow37gzjytuiCSQm9xob6PJy0L4kuQEMTLfUOGvkXvZr7GPrHquMA==", "license": "MIT", + "peer": true, "dependencies": { "@docusaurus/mdx-loader": "3.10.1", "@docusaurus/module-type-aliases": "3.10.1", @@ -4396,6 +4407,7 @@ "resolved": "https://registry.npmjs.org/@docusaurus/utils/-/utils-3.10.1.tgz", "integrity": "sha512-3ojeJry9xBYdJO6qoyyzqeJFSJBVx2mXhyDzSdjwL2+URFQMf+h25gG38iswGImicK0ELjTd1EL2xzk8hf3QPw==", "license": "MIT", + "peer": true, "dependencies": { "@docusaurus/logger": "3.10.1", "@docusaurus/types": "3.10.1", @@ -4441,6 +4453,7 @@ "resolved": "https://registry.npmjs.org/@docusaurus/utils-validation/-/utils-validation-3.10.1.tgz", "integrity": "sha512-cRv1X69jwaWv47waglllgZVWzeBFLhl53XT/XED/83BerVBTC5FTP8WTcVl8Z6sZOegDSwitu/wpCSPCDOT6lg==", "license": "MIT", + "peer": true, "dependencies": { "@docusaurus/logger": "3.10.1", "@docusaurus/utils": "3.10.1", @@ -4528,6 +4541,7 @@ "resolved": "https://registry.npmjs.org/@emotion/react/-/react-11.14.0.tgz", "integrity": "sha512-O000MLDBDdk/EohJPFUqvnp4qnHeYkVP5B0xEG0D/L7cOKP9kefu2DXn8dj74cQfsEzUqh+sr1RzFqiL1o+PpA==", "license": "MIT", + "peer": true, "dependencies": { "@babel/runtime": "^7.18.3", "@emotion/babel-plugin": "^11.13.5", @@ -5119,6 +5133,7 @@ "resolved": "https://registry.npmjs.org/@internationalized/date/-/date-3.12.0.tgz", "integrity": "sha512-/PyIMzK29jtXaGU23qTvNZxvBXRtKbNnGDFD+PY6CZw/Y8Ex8pFUzkuCJCG9aOqmShjqhS9mPqP6Dk5onQY8rQ==", "license": "Apache-2.0", + "peer": true, "dependencies": { "@swc/helpers": "^0.5.0" } @@ -5673,6 +5688,7 @@ "resolved": "https://registry.npmjs.org/@mdx-js/react/-/react-3.1.1.tgz", "integrity": "sha512-f++rKLQgUVYDAtECQ6fn/is15GkEH9+nZPM3MS0RcxVqoTfawHvDlSCH7JbMhAM6uJ32v3eXLvLmLvjGu7PTQw==", "license": "MIT", + "peer": true, "dependencies": { "@types/mdx": "^2.0.0" }, @@ -6623,6 +6639,7 @@ "resolved": "https://registry.npmjs.org/@svgr/core/-/core-8.1.0.tgz", "integrity": "sha512-8QqtOQT5ACVlmsvKOJNEaWmRPmcojMOzCz4Hs2BGG/toAp/K38LcsMRyLp349glq5AzJbCEeimEoxaX6v/fLrA==", "license": "MIT", + "peer": true, "dependencies": { "@babel/core": "^7.21.3", "@svgr/babel-preset": "8.1.0", @@ -7301,18 +7318,6 @@ } } }, - "node_modules/@swagger-api/apidom-parser-adapter-yaml-1-2/node_modules/tree-sitter": { - "version": "0.22.4", - "resolved": "https://registry.npmjs.org/tree-sitter/-/tree-sitter-0.22.4.tgz", - "integrity": "sha512-usbHZP9/oxNsUY65MQUsduGRqDHQOou1cagUSwjhoSYAmSahjQDAVsh9s+SlZkn8X8+O1FULRGwHu7AFP3kjzg==", - "hasInstallScript": true, - "license": "MIT", - "optional": true, - "dependencies": { - "node-addon-api": "^8.3.0", - "node-gyp-build": "^4.8.4" - } - }, "node_modules/@swagger-api/apidom-reference": { "version": "1.11.2", "resolved": "https://registry.npmjs.org/@swagger-api/apidom-reference/-/apidom-reference-1.11.2.tgz", @@ -7666,7 +7671,8 @@ "version": "7.0.15", "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", - "license": "MIT" + "license": "MIT", + "peer": true }, "node_modules/@types/mdast": { "version": "4.0.4", @@ -7753,6 +7759,7 @@ "resolved": "https://registry.npmjs.org/@types/react/-/react-19.2.14.tgz", "integrity": "sha512-ilcTH/UniCkMdtexkoCN0bI7pMcJDvmQFPvuPvmEaYA/NSfFTAgdUSLAoVjaRJm7+6PvcM+q1zYOwS4wTYMF9w==", "license": "MIT", + "peer": true, "dependencies": { "csstype": "^3.2.2" } @@ -9072,6 +9079,7 @@ "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.16.0.tgz", "integrity": "sha512-UVJyE9MttOsBQIDKw1skb9nAwQuR5wuGD3+82K6JgJlm/Y+KI92oNsMNGZCYdDsVtRHSak0pcV5Dno5+4jh9sw==", "license": "MIT", + "peer": true, "bin": { "acorn": "bin/acorn" }, @@ -9161,6 +9169,7 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.20.0.tgz", "integrity": "sha512-Thbli+OlOj+iMPYFBVBfJ3OmCAnaSyNn4M1vz9T6Gka5Jt9ba/HIR56joy65tY6kx/FCF5VXNB819Y7/GUrBGA==", "license": "MIT", + "peer": true, "dependencies": { "fast-deep-equal": "^3.1.3", "fast-uri": "^3.0.1", @@ -9220,6 +9229,7 @@ "resolved": "https://registry.npmjs.org/algoliasearch/-/algoliasearch-5.52.1.tgz", "integrity": "sha512-fHA8+kXTbjagw3jkLiaS7KKrH8qe2DyOsiUhGlN4cdT77PEsfqXZl7ewDk1hsg+pJnPlnE50XtLxjR91iJOpmg==", "license": "MIT", + "peer": true, "dependencies": { "@algolia/abtesting": "1.18.1", "@algolia/client-abtesting": "5.52.1", @@ -9853,6 +9863,7 @@ } ], "license": "MIT", + "peer": true, "dependencies": { "baseline-browser-mapping": "^2.10.12", "caniuse-lite": "^1.0.30001782", @@ -10995,6 +11006,7 @@ "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", "license": "MIT", + "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -12720,6 +12732,7 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.15.0.tgz", "integrity": "sha512-fgFx7Hfoq60ytK2c7DhnF8jIvzYgOMxfugjLOSMHjLIPgenqa7S7oaagATUq99mV6IYvN2tRmC0wnTYX6iPbMw==", "license": "MIT", + "peer": true, "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -14074,6 +14087,7 @@ "resolved": "https://registry.npmjs.org/immutable/-/immutable-3.8.3.tgz", "integrity": "sha512-AUY/VyX0E5XlibOmWt10uabJzam1zlYjwiEgQSDc5+UIkFNaF9WM0JxXKaNMGf+F/ffUF+7kRKXM9A7C0xXqMg==", "license": "MIT", + "peer": true, "engines": { "node": ">=0.10.0" } @@ -17767,6 +17781,7 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.15.0.tgz", "integrity": "sha512-fgFx7Hfoq60ytK2c7DhnF8jIvzYgOMxfugjLOSMHjLIPgenqa7S7oaagATUq99mV6IYvN2tRmC0wnTYX6iPbMw==", "license": "MIT", + "peer": true, "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -18680,6 +18695,7 @@ } ], "license": "MIT", + "peer": true, "dependencies": { "nanoid": "^3.3.11", "picocolors": "^1.1.1", @@ -19583,6 +19599,7 @@ "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", "license": "MIT", + "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -20474,6 +20491,7 @@ "resolved": "https://registry.npmjs.org/ramda/-/ramda-0.30.1.tgz", "integrity": "sha512-tEF5I22zJnuclswcZMc8bDIrwRHRzf+NqVEmqg50ShAZMP7MWeR/RGDthfM/p+BlqvF2fXAzpn8i+SJcYD3alw==", "license": "MIT", + "peer": true, "funding": { "type": "opencollective", "url": "https://opencollective.com/ramda" @@ -20579,6 +20597,7 @@ "resolved": "https://registry.npmjs.org/react/-/react-18.3.1.tgz", "integrity": "sha512-wS+hAgJShR0KhEvPJArfuPVN1+Hz1t0Y6n5jLrGQbkb4urgPE/0Rve+1kMB1v/oWgHgm4WIcV+i7F2pTVj+2iQ==", "license": "MIT", + "peer": true, "dependencies": { "loose-envify": "^1.1.0" }, @@ -20617,6 +20636,7 @@ "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-18.3.1.tgz", "integrity": "sha512-5m4nQKp+rZRb09LNH59GM4BxTh9251/ylbKIbpe7TpGxfJ+9kv6BLkLBXIjjspbgbnIBNqlI23tRnTWT0snUIw==", "license": "MIT", + "peer": true, "dependencies": { "loose-envify": "^1.1.0", "scheduler": "^0.23.2" @@ -20654,6 +20674,7 @@ "resolved": "https://registry.npmjs.org/react-hook-form/-/react-hook-form-7.78.0.tgz", "integrity": "sha512-EEZqc+N23moyzTlz61Pj+JvcXo76ICkpfOZo8JZw+sM4+wLQGh6nI2Ms+PdMOYNluFu0ghlM7B8mCzhRYtJCnA==", "license": "MIT", + "peer": true, "engines": { "node": ">=18.0.0" }, @@ -20746,6 +20767,7 @@ "resolved": "https://registry.npmjs.org/@docusaurus/react-loadable/-/react-loadable-6.0.0.tgz", "integrity": "sha512-YMMxTUQV/QFSnbgrP3tjDzLHRg7vsbMn8e9HAa8o/1iXoiomo48b7sk/kkmWEuWNDPJVlKSJRB6Y2fHqdJk+SQ==", "license": "MIT", + "peer": true, "dependencies": { "@types/react": "*" }, @@ -20823,6 +20845,7 @@ "resolved": "https://registry.npmjs.org/react-redux/-/react-redux-9.3.0.tgz", "integrity": "sha512-KQopgqFo/p/fgmAs5qz6p5RWaNAzq40WAu7fJIXnQpYxFPbJYtsJPWvGeF2rOBaY/kEuV77AVsX8TsQzKm+A/g==", "license": "MIT", + "peer": true, "dependencies": { "@types/use-sync-external-store": "^0.0.6", "use-sync-external-store": "^1.4.0" @@ -20846,6 +20869,7 @@ "resolved": "https://registry.npmjs.org/react-router/-/react-router-5.3.4.tgz", "integrity": "sha512-Ys9K+ppnJah3QuaRiLxk+jDWOR1MekYQrlytiXxC1RyfbdsZkS5pvKAzCCr031xHixZwpnsYNT5xysdFHQaYsA==", "license": "MIT", + "peer": true, "dependencies": { "@babel/runtime": "^7.12.13", "history": "^4.9.0", @@ -21045,7 +21069,8 @@ "version": "5.0.1", "resolved": "https://registry.npmjs.org/redux/-/redux-5.0.1.tgz", "integrity": "sha512-M9/ELqF6fy8FwmkpnF0S3YKOqMyoWJ4+CS5Efg2ct3oY9daQvd/Pc71FpGZsVsbl3Cpb+IIcjBDUnnyBdQbq4w==", - "license": "MIT" + "license": "MIT", + "peer": true }, "node_modules/redux-immutable": { "version": "4.0.0", @@ -21696,6 +21721,7 @@ "resolved": "https://registry.npmjs.org/sass/-/sass-1.101.0.tgz", "integrity": "sha512-OL3GoQyoUdDt843DpVmDO6y2k1sc5IhUDSpu8XucEI+35neq5QivZ1iuegnpraEVTJXlQGK1gl27zKcTLEPbQw==", "license": "MIT", + "peer": true, "dependencies": { "chokidar": "^5.0.0", "immutable": "^5.1.5", @@ -23132,6 +23158,7 @@ "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.4.tgz", "integrity": "sha512-QP88BAKvMam/3NxH6vj2o21R6MjxZUAd6nlwAS/pnGvN9IVLocLHxGYIzFhg6fUQ+5th6P4dv4eW9jX3DSIj7A==", "license": "MIT", + "peer": true, "engines": { "node": ">=12" }, @@ -23236,18 +23263,6 @@ "tslib": "2" } }, - "node_modules/tree-sitter": { - "version": "0.21.1", - "resolved": "https://registry.npmjs.org/tree-sitter/-/tree-sitter-0.21.1.tgz", - "integrity": "sha512-7dxoA6kYvtgWw80265MyqJlkRl4yawIjO7S5MigytjELkX43fV2WsAXzsNfO7sBpPPCF5Gp0+XzHk0DwLCq3xQ==", - "hasInstallScript": true, - "license": "MIT", - "optional": true, - "dependencies": { - "node-addon-api": "^8.0.0", - "node-gyp-build": "^4.8.0" - } - }, "node_modules/tree-sitter-json": { "version": "0.24.8", "resolved": "https://registry.npmjs.org/tree-sitter-json/-/tree-sitter-json-0.24.8.tgz", @@ -23336,7 +23351,8 @@ "version": "2.8.1", "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", - "license": "0BSD" + "license": "0BSD", + "peer": true }, "node_modules/tsyringe": { "version": "4.10.0", @@ -23419,6 +23435,7 @@ "integrity": "sha512-hjcS1mhfuyi4WW8IWtjP7brDrG2cuDZukyrYrSauoXGNgx0S7zceP07adYkJycEr56BOUTNPzbInooiN3fn1qw==", "devOptional": true, "license": "Apache-2.0", + "peer": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" @@ -23797,6 +23814,7 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.15.0.tgz", "integrity": "sha512-fgFx7Hfoq60ytK2c7DhnF8jIvzYgOMxfugjLOSMHjLIPgenqa7S7oaagATUq99mV6IYvN2tRmC0wnTYX6iPbMw==", "license": "MIT", + "peer": true, "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -24087,6 +24105,7 @@ "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.106.2.tgz", "integrity": "sha512-wGN3qcrBQIFmQ/c0AiOAQBvrZ5lmY8vbbMv4Mxfgzqd/B6+9pXtLo73WuS1dSGXM5QYY3hZnIbvx+K1xxe6FyA==", "license": "MIT", + "peer": true, "dependencies": { "@types/eslint-scope": "^3.7.7", "@types/estree": "^1.0.8", diff --git a/scripts/patch-api-info.js b/scripts/patch-api-info.js index 528ba7e9..3f7a5bb8 100644 --- a/scripts/patch-api-info.js +++ b/scripts/patch-api-info.js @@ -1,18 +1,27 @@ #!/usr/bin/env node /** - * Patches the generated *.info.mdx files after `docusaurus gen-api-docs`. + * Patches generated files after `docusaurus gen-api-docs`. * * The openapi-docs plugin regenerates these files from the spec on every run, - * discarding manual edits. This script reapplies two fixes automatically for - * each generated API reference: + * discarding manual edits. This script reapplies fixes automatically for each + * generated API reference: * - * 1. Adds `displayed_sidebar: ` to the frontmatter so the page - * renders inside the correct product sidebar. + * 1. Adds `displayed_sidebar: ` to the info doc's frontmatter so + * the page renders inside the correct product sidebar. * * 2. Inserts the license name into the License section, which the plugin * generates as an empty heading. Skipped when the spec has no license or * isn't available as a local file (e.g. it's fetched from a remote URL). * + * 3. Normalizes operation titles generated straight from the spec's + * `summary` field, which mixes imperative ("Create a preset") and + * third-person-singular ("Creates a preset") verb forms depending on how + * each endpoint's summary was written upstream. Strips a trailing period + * and the trailing "s" off a third-person-singular leading verb, so + * every title reads as an imperative ("Creates a preset." -> "Create a + * preset"). Applied to each *.api.mdx file's title/sidebar_label/heading + * and the matching label in that directory's sidebar.ts. + * * Every step is existsSync-guarded and idempotent, so running this after a * single-spec regeneration (only one info file present) is safe. */ @@ -36,6 +45,29 @@ const TARGETS = [ sidebar: 'rdeSidebar', specFile: null, }, + { + infoFile: '../docs/release-management-api/apps/api-reference/release-management-api.info.mdx', + sidebar: 'releaseManagementSidebar', + specFile: '../api/bitrise-rm-apps.json', + }, + { + infoFile: + '../docs/release-management-api/store-releases/api-reference/release-management-api-app-versions.info.mdx', + sidebar: 'releaseManagementSidebar', + specFile: '../api/bitrise-rm-store-releases.json', + }, + { + infoFile: + '../docs/release-management-api/code-push/api-reference/release-management-api-codepush.info.mdx', + sidebar: 'releaseManagementSidebar', + specFile: '../api/bitrise-rm-code-push.json', + }, + { + infoFile: + '../docs/release-management-api/build-distributions/api-reference/release-management-api-build-distributions.info.mdx', + sidebar: 'releaseManagementSidebar', + specFile: '../api/bitrise-rm-build-distributions.json', + }, ]; for (const target of TARGETS) { @@ -76,6 +108,9 @@ for (const target of TARGETS) { } fs.writeFileSync(filePath, content, 'utf-8'); + + // 3. Normalize operation titles in every *.api.mdx sibling of this info file. + normalizeOperationTitles(path.dirname(filePath)); } console.log('✔ Patch complete'); @@ -87,3 +122,54 @@ function readLicenseName(specFile) { const spec = JSON.parse(fs.readFileSync(specPath, 'utf-8')); return spec?.info?.license?.name ?? null; } + +// Strip a lone trailing period, then fix a leading third-person-singular verb +// ("Gets" -> "Get"). Guards against words ending in a doubled "s" (Access, +// Process, …), which aren't third-person-singular verbs and would otherwise +// get mangled. +function normalizeTitle(title) { + let t = title.trim(); + if (t.endsWith('.') && !t.endsWith('..')) { + t = t.slice(0, -1); + } + t = t.replace(/^([A-Z][a-z]+)s(\s|$)/, (whole, verb, ws) => { + if (verb.endsWith('s')) return whole; + return verb + ws; + }); + return t; +} + +function normalizeOperationTitles(dir) { + const apiFiles = fs.readdirSync(dir).filter(f => f.endsWith('.api.mdx')); + const sidebarPath = path.join(dir, 'sidebar.ts'); + let sidebarContent = fs.existsSync(sidebarPath) ? fs.readFileSync(sidebarPath, 'utf-8') : null; + let changedCount = 0; + + for (const file of apiFiles) { + const filePath = path.join(dir, file); + let content = fs.readFileSync(filePath, 'utf-8'); + const match = content.match(/^title: "(.*)"$/m); + if (!match) continue; + + const oldTitle = match[1]; + const newTitle = normalizeTitle(oldTitle); + if (newTitle === oldTitle) continue; + + // title / sidebar_label / Heading children all carry the exact same + // string — replace every literal occurrence. + content = content.split(`"${oldTitle}"`).join(`"${newTitle}"`); + fs.writeFileSync(filePath, content, 'utf-8'); + changedCount++; + + if (sidebarContent) { + sidebarContent = sidebarContent.split(`label: "${oldTitle}"`).join(`label: "${newTitle}"`); + } + } + + if (sidebarContent !== null) { + fs.writeFileSync(sidebarPath, sidebarContent, 'utf-8'); + } + if (changedCount > 0) { + console.log(`✔ normalized ${changedCount} operation title(s) in ${path.relative(path.resolve(__dirname, '..'), dir)}`); + } +} diff --git a/scripts/rm_apps_spec_sync_state.json b/scripts/rm_apps_spec_sync_state.json new file mode 100644 index 00000000..7a81e2ab --- /dev/null +++ b/scripts/rm_apps_spec_sync_state.json @@ -0,0 +1,6 @@ +{ + "etag": "", + "sha256": "41b324dabcd6fcd238fb247b355d143e8fc4b2e522a7759d2419e2b940772e95", + "last_checked": "2026-07-23T19:34:15.928423+00:00", + "last_changed": "2026-07-23T19:34:15.928423+00:00" +} diff --git a/scripts/rm_build_distributions_spec_sync_state.json b/scripts/rm_build_distributions_spec_sync_state.json new file mode 100644 index 00000000..8fbb2762 --- /dev/null +++ b/scripts/rm_build_distributions_spec_sync_state.json @@ -0,0 +1,6 @@ +{ + "etag": "", + "sha256": "3999f27dfe724d1a93e46c41fd5e4429dc428c78d9fbd7f2160542d56a97a54f", + "last_checked": "2026-07-23T19:34:18.568690+00:00", + "last_changed": "2026-07-23T19:34:18.568690+00:00" +} diff --git a/scripts/rm_code_push_spec_sync_state.json b/scripts/rm_code_push_spec_sync_state.json new file mode 100644 index 00000000..cde758dc --- /dev/null +++ b/scripts/rm_code_push_spec_sync_state.json @@ -0,0 +1,6 @@ +{ + "etag": "", + "sha256": "6b18f1f5c1965b722e6993342d77f4bf262edccb33b554f1fd341dec7f06abe1", + "last_checked": "2026-07-23T19:34:17.828305+00:00", + "last_changed": "2026-07-23T19:34:17.828305+00:00" +} diff --git a/scripts/rm_store_releases_spec_sync_state.json b/scripts/rm_store_releases_spec_sync_state.json new file mode 100644 index 00000000..c75f9901 --- /dev/null +++ b/scripts/rm_store_releases_spec_sync_state.json @@ -0,0 +1,6 @@ +{ + "etag": "", + "sha256": "ea69706d965045d5c3c5a0ccdb843d357eff493be3031b65c75d1381bf89bd63", + "last_checked": "2026-07-23T19:34:16.924333+00:00", + "last_changed": "2026-07-23T19:34:16.924333+00:00" +} diff --git a/scripts/sync_rm_apps_spec.py b/scripts/sync_rm_apps_spec.py new file mode 100644 index 00000000..68035c75 --- /dev/null +++ b/scripts/sync_rm_apps_spec.py @@ -0,0 +1,31 @@ +#!/usr/bin/env python3 +""" +Detect changes in the Release Management Apps API spec and update +api/bitrise-rm-apps.json. + +Thin wrapper over scripts/spec_sync.py; see that module for the strategy +(ETag conditional GET + SHA-256 content gate). + +Usage: + python3 scripts/sync_rm_apps_spec.py # check for changes + python3 scripts/sync_rm_apps_spec.py --update # force-refresh the stored state + +Output (JSON to stdout): { "status": "unchanged" | "changed" | "initialized", ... } + +On "changed"/"initialized", api/bitrise-rm-apps.json is overwritten. Run +`npm run gen-api-docs` afterwards to regenerate the reference pages. +""" + +import json +import sys +from pathlib import Path + +from spec_sync import run_sync + +SPEC_URL = "https://api.bitrise.io/release-management/api-docs/release_management/v2/swagger.json" +STATE_FILE = Path(__file__).parent / "rm_apps_spec_sync_state.json" +SPEC_FILE = Path(__file__).parent.parent / "api" / "bitrise-rm-apps.json" + +if __name__ == "__main__": + result = run_sync(SPEC_URL, STATE_FILE, SPEC_FILE, force_update="--update" in sys.argv) + print(json.dumps(result)) diff --git a/scripts/sync_rm_build_distributions_spec.py b/scripts/sync_rm_build_distributions_spec.py new file mode 100644 index 00000000..8f438b99 --- /dev/null +++ b/scripts/sync_rm_build_distributions_spec.py @@ -0,0 +1,32 @@ +#!/usr/bin/env python3 +""" +Detect changes in the Release Management Build Distributions API spec and +update api/bitrise-rm-build-distributions.json. + +Thin wrapper over scripts/spec_sync.py; see that module for the strategy +(ETag conditional GET + SHA-256 content gate). + +Usage: + python3 scripts/sync_rm_build_distributions_spec.py # check for changes + python3 scripts/sync_rm_build_distributions_spec.py --update # force-refresh the stored state + +Output (JSON to stdout): { "status": "unchanged" | "changed" | "initialized", ... } + +On "changed"/"initialized", api/bitrise-rm-build-distributions.json is +overwritten. Run `npm run gen-api-docs` afterwards to regenerate the +reference pages. +""" + +import json +import sys +from pathlib import Path + +from spec_sync import run_sync + +SPEC_URL = "https://api.bitrise.io/release-management/api-docs/release_management/v2/build_distributions/swagger.json" +STATE_FILE = Path(__file__).parent / "rm_build_distributions_spec_sync_state.json" +SPEC_FILE = Path(__file__).parent.parent / "api" / "bitrise-rm-build-distributions.json" + +if __name__ == "__main__": + result = run_sync(SPEC_URL, STATE_FILE, SPEC_FILE, force_update="--update" in sys.argv) + print(json.dumps(result)) diff --git a/scripts/sync_rm_code_push_spec.py b/scripts/sync_rm_code_push_spec.py new file mode 100644 index 00000000..6598d3ff --- /dev/null +++ b/scripts/sync_rm_code_push_spec.py @@ -0,0 +1,31 @@ +#!/usr/bin/env python3 +""" +Detect changes in the Release Management CodePush API spec and update +api/bitrise-rm-code-push.json. + +Thin wrapper over scripts/spec_sync.py; see that module for the strategy +(ETag conditional GET + SHA-256 content gate). + +Usage: + python3 scripts/sync_rm_code_push_spec.py # check for changes + python3 scripts/sync_rm_code_push_spec.py --update # force-refresh the stored state + +Output (JSON to stdout): { "status": "unchanged" | "changed" | "initialized", ... } + +On "changed"/"initialized", api/bitrise-rm-code-push.json is overwritten. Run +`npm run gen-api-docs` afterwards to regenerate the reference pages. +""" + +import json +import sys +from pathlib import Path + +from spec_sync import run_sync + +SPEC_URL = "https://api.bitrise.io/release-management/api-docs/release_management/v2/code_push/swagger.json" +STATE_FILE = Path(__file__).parent / "rm_code_push_spec_sync_state.json" +SPEC_FILE = Path(__file__).parent.parent / "api" / "bitrise-rm-code-push.json" + +if __name__ == "__main__": + result = run_sync(SPEC_URL, STATE_FILE, SPEC_FILE, force_update="--update" in sys.argv) + print(json.dumps(result)) diff --git a/scripts/sync_rm_store_releases_spec.py b/scripts/sync_rm_store_releases_spec.py new file mode 100644 index 00000000..4dd95fe8 --- /dev/null +++ b/scripts/sync_rm_store_releases_spec.py @@ -0,0 +1,31 @@ +#!/usr/bin/env python3 +""" +Detect changes in the Release Management Store Releases (app versions) API +spec and update api/bitrise-rm-store-releases.json. + +Thin wrapper over scripts/spec_sync.py; see that module for the strategy +(ETag conditional GET + SHA-256 content gate). + +Usage: + python3 scripts/sync_rm_store_releases_spec.py # check for changes + python3 scripts/sync_rm_store_releases_spec.py --update # force-refresh the stored state + +Output (JSON to stdout): { "status": "unchanged" | "changed" | "initialized", ... } + +On "changed"/"initialized", api/bitrise-rm-store-releases.json is overwritten. +Run `npm run gen-api-docs` afterwards to regenerate the reference pages. +""" + +import json +import sys +from pathlib import Path + +from spec_sync import run_sync + +SPEC_URL = "https://api.bitrise.io/release-management/api-docs/release_management/v2/app_versions/swagger.json" +STATE_FILE = Path(__file__).parent / "rm_store_releases_spec_sync_state.json" +SPEC_FILE = Path(__file__).parent.parent / "api" / "bitrise-rm-store-releases.json" + +if __name__ == "__main__": + result = run_sync(SPEC_URL, STATE_FILE, SPEC_FILE, force_update="--update" in sys.argv) + print(json.dumps(result)) diff --git a/sidebars.ts b/sidebars.ts index 9819fab9..4a9da226 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -1,6 +1,10 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; import bitriseAPIApiSidebar from './docs/bitrise-api/api-reference/sidebar'; import rdeAPIApiSidebar from './docs/bitrise-rde-api/api-reference/sidebar'; +import rmAppsApiSidebar from './docs/release-management-api/apps/api-reference/sidebar'; +import rmStoreReleasesApiSidebar from './docs/release-management-api/store-releases/api-reference/sidebar'; +import rmCodePushApiSidebar from './docs/release-management-api/code-push/api-reference/sidebar'; +import rmBuildDistributionsApiSidebar from './docs/release-management-api/build-distributions/api-reference/sidebar'; function productSidebar(dirName: string, title: string) { return [ @@ -45,12 +49,74 @@ function toHubItems(generated: any, addIcon = true) { const hubItems = toHubItems(bitriseAPIApiSidebar); const rdeHubItems = toHubItems(rdeAPIApiSidebar, false); +const rmAppsHubItems = toHubItems(rmAppsApiSidebar, false); +const rmStoreReleasesHubItems = toHubItems(rmStoreReleasesApiSidebar, false); +const rmCodePushHubItems = toHubItems(rmCodePushApiSidebar, false); +const rmBuildDistributionsHubItems = toHubItems(rmBuildDistributionsApiSidebar, false); const sidebars: SidebarsConfig = { platformSidebar: productSidebar('bitrise-platform', 'Bitrise as a Platform'), ciSidebar: productSidebar('bitrise-ci', 'Bitrise CI'), buildCacheSidebar: productSidebar('bitrise-build-cache', 'Build Cache'), - releaseManagementSidebar: productSidebar('release-management', 'Release Management'), + releaseManagementSidebar: [ + ...productSidebar('release-management', 'Release Management'), + { + type: 'category', + label: 'API reference', + collapsed: true, + customProps: {icon: 'Code'}, + items: [ + { + type: 'category', + label: 'Apps', + items: [ + { + type: 'doc', + id: 'release-management-api/apps/api-reference/release-management-api', + label: 'Introduction', + }, + ...rmAppsHubItems, + ], + }, + { + type: 'category', + label: 'Store releases', + items: [ + { + type: 'doc', + id: 'release-management-api/store-releases/api-reference/release-management-api-app-versions', + label: 'Introduction', + }, + ...rmStoreReleasesHubItems, + ], + }, + { + type: 'category', + label: 'CodePush', + items: [ + { + type: 'doc', + id: 'release-management-api/code-push/api-reference/release-management-api-codepush', + label: 'Introduction', + }, + ...rmCodePushHubItems, + ], + }, + { + type: 'category', + label: 'Build distributions', + items: [ + { + type: 'doc', + id: 'release-management-api/build-distributions/api-reference/release-management-api-build-distributions', + label: 'Introduction', + }, + ...rmBuildDistributionsHubItems, + ], + }, + ], + }, + ], insightsSidebar: productSidebar('insights', 'Insights'), buildHubSidebar: productSidebar('bitrise-build-hub', 'Build Hub'), rdeSidebar: [