Skip to main content

Versioning Automated Testing Interface (v0.1.2)

Esta interface é fornecida por um USS (UAS Service Supplier) que deseja fornecer informações sobre a(s) versão(ões) do seu software para destinatários autorizados de maneira automatizada.

Segurança (Autenticação)

  • Tipo: OAuth2 (Client Credentials)

  • Escopo Necessário: interuss.versioning.read_system_versions

  • Descrição: Permite que o cliente leia a(s) versão(ões) do software do USS implantado neste ambiente. O token JWT deve ser enviado no header Authorization: Bearer <token>.

Endpoints

1. Consultar Versão do Sistema (System Version)

Rota: GET /versions/{system_identity}

Obtém a versão do sistema solicitado com base em seu identificador de limite (system boundary).

  • Parâmetros de Rota: system_identity (obrigatório) - Um identificador de limite de sistema conhecido tanto pelo cliente quanto pelo USS. O valor deve ser URL-safe (geralmente estruturado em ordem reversa de domínio, similar a pacotes Java). Exemplo: gov.eu.uspace.v1.netid ou gov.au.casa.operating_rules.v2_6.

  • Respostas Esperadas:

    • 200 OK: A interface forneceu com sucesso a versão do sistema/limite solicitado. Retorna o schema GetVersionResponse.

    • 401 Unauthorized: Token ausente, não decodificado ou inválido.

    • 403 Forbidden: O token foi decodificado com sucesso, mas não inclui o escopo apropriado para este endpoint.

    • 404 Not Found: A identidade/limite do sistema solicitada não é conhecida, ou a interface de automação de versão não está disponível.

Payload de Exemplo (JSON)

Exemplo de Resposta de Versão (GET /versions/{system_identity})

Formato esperado retornando a identidade do sistema solicitado e sua versão atual (preferencialmente utilizando controle de versão semântico).

{
  "system_identity": "gov.au.casa.operating_rules.v2_6",
  "system_version": "v2.19.53117-rc8+d3a7521f"
}