Zum Hauptinhalt springen

Get an app version

GET/apps/{appId}/versions/{appVersionId}/
v2
GET
app-get-appversion

Request​

  • appIdstring (uuid)
    required
  • appVersionIdstring (uuid)
    required

Responses​

application/json

The appVersion object.

  • appIdstring (uuid)
    required
  • backendPathTemplatestring
  • breakingNoteobject

    A BreakingNote is a hint that something serious has changed in the AppVersion containing it, so an automatic update is not possible.

    • faqLinkstring (uri)
      required
  • databasesarray of object
    • Array[

      A DatabaseDependency is a generic description of need for a database, used by AppVersions.

      • *object

        A DatabaseDependency is a generic description of need for a database, used by AppVersions.

        • descriptionstring
          required
        • kind"mysql"
          required
        • parametersobject
          • *string
        • versionstring (uuid)
          required
      ]
  • defaultCronjobsarray of object
    • Array[
      • *object
        • activeboolean
          required
        • commandobject
          • interpreterTemplatestring
            required
          • parametersTemplatestring
          • pathTemplatestring
            required
        • descriptionstring
          required
        • intervalstring
          required
        • timeoutinteger (int32)
          required
        • urlTemplatestring
      ]
  • docRootstring
    required
  • docRootUserEditableboolean
    required
  • externalVersionstring
    required
  • idstring (uuid)
    required
  • internalVersionstring
    required
  • recommendedboolean
  • requestHandlerobject

    RequestHandlerRequirement describes the necessary properties to internally resolve the request handler or process to start.

    • exampleValuesarray of object
      • Array[

        A SavedUserInput is an entered value for a desired UserInput of an AppVersion or SystemSoftwareVersion.

        • *object

          A SavedUserInput is an entered value for a desired UserInput of an AppVersion or SystemSoftwareVersion.

          • namestring
            required
          • valuestring
            required
        ]
    • namestring
      required
    • namespacestring
      required
    • parametersTemplatestring
      required
  • systemSoftwareDependenciesarray of object
    • Array[

      A SystemSoftwareDependency is a description of a need for a specific SystemSoftware in a semver versionRange.

      • *object

        A SystemSoftwareDependency is a description of a need for a specific SystemSoftware in a semver versionRange.

        • systemSoftwareIdstring (uuid)
          required
        • versionRangestring
          required
      ]
  • userInputsarray of object
    • Array[

      A UserInput is a description of an information which cannot be determined or estimated by mittwald, but has to be given by the person who is requesting an AppInstallation or SystemSoftware.

      • *object

        A UserInput is a description of an information which cannot be determined or estimated by mittwald, but has to be given by the person who is requesting an AppInstallation or SystemSoftware.

        • additionalValidationSchemaobject

          AdditionalValidationSchema is a stringified custom validation schema, e.g password rules.

          • kind"password-rule"

            AdditionalValidationSchemaKind is an enum, describing the possible types of an additional validation schema.

          • schemastring
        • dataSourcestring

          Optional field to tell the frontend, which data to put into the select.

        • dataTypestring (one of: text, number, boolean, select)
          required

          UserInputDataType is an enum, describing the possible data types of a UserInput.

        • defaultValuestring
        • formatstring (one of: email, password, url, uri)

          UserInputFormat is an enum, describing the possible data formats of a UserInput, the given values can be validated against.

        • lifecycleConstraintstring (one of: installation, update, reconfigure)
          required

          The AppInstallationLifecycle can be used to express a specific point in the AppInstallation Lifecycle, e.g. while installing a new AppInstallation.

        • namestring
          required
        • positionMetaobject

          UserInputPositionMeta is a utility information, helping to position the UserInput properly on the frontend.

          • indexinteger
          • sectionstring
          • stepstring
        • requiredboolean
          required
        • validationSchemastring
          required

          JSON Schema formatted (https://json-schema.org/).

      ]

Usage examples​

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/apps/f0f86186-0a5a-45b2-aa33-502777496347/versions/f0f86186-0a5a-45b2-aa33-502777496347