Skip to content

r1.1

Pre-release
Pre-release

Choose a tag to compare

View all tags
@camara-release-automation camara-release-automation released this 20 Oct 16:23
r1.1
672604e
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Release Notes

This release candidate contains the definition and documentation of

  • qos-profiles 1.2.0-rc.4

The API definition(s) are based on

  • Commonalities r4.4 (0.9.0)
  • Identity and Consent Management r4.2 (0.5.0)

qos-profiles 1.2.0-rc.4

qos-profiles 1.2.0-rc.4 is a release-candidate version of this API.

Breaking changes

  • No breaking changes for API consumers: the HTTP method, path, request and response payloads are unchanged. Note that the operationId retrieveQoSProfiles was renamed to retrieveQosProfiles (#16), so code generated from the spec (client/server stubs) and test tooling that references the operationId or scenario tags will need updating.

Added

  • New test scenario @qos_profiles_retrieveQosProfiles_02b_filter_by_name_not_found: calling retrieveQosProfiles with a name that matches no profile returns 200 with an empty array (#26)

Changed

  • The API moved from QualityOnDemand to the new QoSProfiles repository. externalDocs.url now points to https://github.com/camaraproject/QoSProfiles (#18)
  • The API description no longer limits QoS Profiles to Quality-On-Demand. It now lists QualityOnDemand, QoSBooking, DedicatedNetworks and NetworkSliceBooking as the APIs that use it (#19)
  • Aligned with Commonalities r4.4 (x-camara-commonalities: 0.9.0), including the updated additional-error-responses description template (#12, #26)
  • Error responses now use the Commonalities r4.4 response catalogue (BadRequest400, Unauthenticated401, PermissionDenied403, NotFound404, IdentifierNotFound404, TooManyRequests429) instead of the API's own Generic* definitions. Generic422 is renamed to RetrieveQosProfilesUnprocessable422 and uses the common *_DEVICE 422 examples (#26)
  • The 404 response of retrieveQosProfiles now declares only IDENTIFIER_NOT_FOUND. NOT_FOUND was removed because this operation has no resource path that can be missing (#26)
  • The Duration.value maximum is reduced from 2147483647 to 99999 (#24, #29)
  • Test definitions: schema pointers now use the #/components/... form throughout (#26)

Fixed

  • The operationId retrieveQoSProfiles is corrected to retrieveQosProfiles. The feature file and scenario tags were renamed to match (#16)
  • The countryName description now cites ISO 3166-1 alpha-2 instead of ISO 3166-2 (#14)
  • The "DCSP" typo in the serviceClass table is now "DSCP", and the reference to the archived HomeDevicesQoD API is removed (#15)
  • The CAMARA API Design Guide link now points to Commonalities r4.4 instead of r3.3 (#17, #26)

Removed

  • The API's own error response components Generic400, Generic401, Generic403, NotFound404, RetrieveQosProfilesNotFound404 and Generic429. Commonalities references replace them (#26)

Full Changelog: https://github.com/camaraproject/QoSProfiles/commits/r1.1

Assets 2
Loading