Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ NOTE:

## Table of contents

- **[r1.2](#r12) (Fall25 public release)**
- **[r1.1](#r11)**

**Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until it has been released. For example, changes may be reverted before a release is published. For the best results, use the latest published release.**
Expand All @@ -15,6 +16,42 @@ The below sections record the changes for each API version in each release as fo
* for subsequent release-candidate(s), only the delta to the previous release-candidate
* for a public release, the consolidated changes since the previous public release
Note: this API had former releases in the [ConnectivityInsights](https://github.com/camaraproject/ConnectivityInsights/releases) repository.

# r1.2
## Release Notes

This public release contains the definition and documentation of
* application-profiles v0.5.0

The API definition(s) are based on
* Commonalities v0.6.0 (r3.3)
* Identity and Consent Management v0.4.0 (r3.3)

* **r1.2 release of ApplicationProfiles has the following API definitions:**

* **application-profiles v0.5.0**
[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml&nocors)
[[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml)
[[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml)

### Added

* New `DeviceResponse` object in responses limited to one identifier.
* Clarifications on non-documented error responses.
* Support for compute resource requirements related to the application.

### Changed

* Updated string pattern for `x-correlator`headers.

### Removed

* `verificationResult: UNKNOWN` for 200 responses.
* Error `422 IDENTIFIER_MISMATCH`.
* Error `401 AUTHENTICATION_REQUIRED`.

**Full Changelog**: https://github.com/camaraproject/ApplicationProfiles/compare/r1.1...r1.2

# r1.1
## Release Notes

Expand Down
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,19 @@ Sandbox API Repository to describe, develop, document, and test the ApplicationP

## Release Information

**NEW**: First pre-release [r1.1](https://github.com/camaraproject/ApplicationProfiles/releases/tag/r1.1) with application-profiles v0.5.0-rc.1 is available.
**NEW**: public release [r1.2](https://github.com/camaraproject/ApplicationProfiles/releases/tag/r1.2) is available with the following API versions:

* **application-profiles v0.5.0**
[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml&nocors)
[[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml)
[[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml)

Prior releases of application-profiles (as a sub project in connectivity insights) up to version 0.4.0 as part of the Fall25 meta-release are available within [ConnectivityInsights](https://github.com/camaraproject/ConnectivityInsights/releases).

<!-- Optional: an explicit listing of the latest (pre-)release with additional information, e.g. links to the API definitions -->
<!-- In addition use/uncomment one or multiple the following alternative options when becoming applicable -->
Pre-releases of this sub project are available in https://github.com/camaraproject/ApplicationProfiles/releases
<!-- The latest public release is available here: https://github.com/camaraproject/ApplicationProfiles/releases/latest -->
For changes see [CHANGELOG.md](https://github.com/camaraproject/ApplicationProfiles/blob/main/CHANGELOG.md)

* The latest public release is available here: https://github.com/camaraproject/ApplicationProfiles/releases/latest
* Other releases of this sub project are available in https://github.com/camaraproject/ApplicationProfiles/releases
* For changes see [CHANGELOG.md](https://github.com/camaraproject/ApplicationProfiles/blob/main/CHANGELOG.md)

## Contributing
* Meetings are held virtually together with ConnectivityInsights
Expand Down
11 changes: 5 additions & 6 deletions code/API_definitions/application-profiles.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ openapi: 3.0.3
info:
title: Connectivity Insights - Application Profiles
x-camara-commonalities: 0.6
version: wip
version: 0.5.0
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
Expand Down Expand Up @@ -64,7 +64,7 @@ externalDocs:
description: Project documentation at Camara
url: https://github.com/camaraproject/ApplicationProfiles
servers:
- url: "{apiRoot}/application-profiles/vwip"
- url: "{apiRoot}/application-profiles/v0.5"
variables:
apiRoot:
default: https://localhost:9091
Expand Down Expand Up @@ -498,21 +498,20 @@ components:

ErrorInfo:
type: object
description: Error information
required:
- status
- code
- message
properties:
status:
type: integer
description: HTTP status code returned along with this error response
description: HTTP response status code
code:
type: string
description: Code given to this error
description: A human-readable code to describe the error
message:
type: string
description: Detailed error description
description: A human-readable description of what the event represents

responses:
Generic400:
Expand Down
5 changes: 3 additions & 2 deletions code/Test_definitions/application-profiles.feature
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
@Application_Profiles
Feature: CAMARA Application Profiles API, vwip - Operations for Application Profiles
Feature: CAMARA Application Profiles API, v0.5.0 - Operations for Application Profiles

# Input to be provided by the implementation to the tests
# References to OAS spec schemas refer to schemas specified in application-profiles.yaml

Background: Common Application Profiles setup
Given the resource "{apiroot}/application-profiles/vwip" as base-url
Given an environment at "apiRoot"
And the resource "/application-profiles/v0.5"
And the header "Content-Type" is set to "application/json"
And the header "Authorization" is set to a valid access token
And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# API Readiness Checklist

Checklist for application-profiles v0.5.0-rc.1 in r1.1
Checklist for application-profiles v0.5.0 in r1.2

| Nr | API release assets | alpha | release-candidate | initial<br>public | stable<br> public | Status | Reference information |
|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----|
| 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/application-profiles.yaml) |
| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.2](https://github.com/camaraproject/Commonalities/releases/tag/r3.2) |
| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.2](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.2) |
| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) |
| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) |
| 4 | API versioning convention applied | M | M | M | M | Y | |
| 5 | API documentation | M | M | M | M | Y | inline in YAML |
| 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/application-profiles-User-Story.md) |
Expand Down