Skip to content

Commit

Permalink
Merge remote-tracking branch 'refs/remotes/origin/main' into fix/refo…
Browse files Browse the repository at this point in the history
…rmat-tables-styles-grammars-in-mds

# Conflicts:
#	documentation/Camara_Versioning_Guidelines.md
  • Loading branch information
maxl2287 committed Jul 1, 2024
2 parents 959c064 + 30796d9 commit 40c8899
Show file tree
Hide file tree
Showing 5 changed files with 175 additions and 79 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ A list of some of the frequently accessed documents that are an output of the wo
|-------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [API-design-guidelines.md](documentation/API-design-guidelines.md) | This document captures guidelines for the API design in CAMARA project. These guidelines are applicable to every API to be worked out under the CAMARA initiative. |
| [API-DocumentationTemplate.md](documentation/API-DocumentationTemplate.md) | Template for documenting the APIs |
| [API-Readiness-Checklist.md](documentation/API-Readiness-Checklist.md) | A checklist that describes the minimum criteria for considering an API Ready |
| [Camara_Versioning_Guidelines.md](documentation/Camara_Versioning_Guidelines.md) | Guidelines for API Subprojects on making releases |
| [Glossary.md](documentation/Glossary.md) | A glossary of the common terms and their API parameter/field names for use in the APIs |
| [API-Testing-Guidelines.md](documentation/API-Testing-Guidelines.md) | Guidelines for the API testing in CAMARA project |

NOTE: Guidelines for Release Management of API versions, e.g. the API-Readiness-Checklist, are located within [ReleaseManagement](https://github.com/camaraproject/ReleaseManagement). The versioning of APIs is defined within the [API-design-guidelines.md](documentation/API-design-guidelines.md#5-versioning).


## Status and released versions

Expand Down
3 changes: 2 additions & 1 deletion artifacts/CAMARA_common.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ components:
* `ipv6Address`
* `phoneNumber`
* `networkAccessIdentifier`
NOTE: the MNO might support only a subset of these options. The API invoker can provide multiple identifiers to be compatible across different MNOs. In this case the identifiers MUST belong to the same device.
NOTE1: the MNO might support only a subset of these options. The API invoker can provide multiple identifiers to be compatible across different MNOs. In this case the identifiers MUST belong to the same device.
NOTE2: for the Commonalities release v0.4, we are enforcing that the networkAccessIdentifier is only part of the schema for future-proofing, and CAMARA does not currently allow its use. After the CAMARA meta-release work is concluded and the relevant issues are resolved, its use will need to be explicitly documented in the guidelines.
type: object
properties:
phoneNumber:
Expand Down
6 changes: 6 additions & 0 deletions artifacts/camara-cloudevents/event-subscription-template.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,8 @@ components:
Note: for the Commonalities meta-release v0.4 we enforce to have only event type per subscription then for following meta-release use of array MUST be decided
at API project level.
type: array
minItems: 1
maxItems: 1
items:
type: string
config:
Expand Down Expand Up @@ -487,6 +489,8 @@ components:
Note: for the Commonalities meta-release v0.4 we enforce to have only event type per subscription then for following meta-release use of array MUST be decided
at API project level.
type: array
minItems: 1
maxItems: 1
items:
type: string
config:
Expand Down Expand Up @@ -633,11 +637,13 @@ components:
- SUBSCRIPTION_EXPIRED - Subscription expire time (optionally set by the requester) has been reached
- MAX_EVENTS_REACHED - Maximum number of events (optionally set by the requester) has been reached
- ACCESS_TOKEN_EXPIRED - Access Token sinkCredential (optionally set by the requester) expiration time has been reached
- SUBSCRIPTION_DELETED - Subscription was deleted by the requester
enum:
- MAX_EVENTS_REACHED
- NETWORK_TERMINATED
- SUBSCRIPTION_EXPIRED
- ACCESS_TOKEN_EXPIRED
- SUBSCRIPTION_DELETED

HTTPSubscriptionRequest:
allOf:
Expand Down
Loading

0 comments on commit 40c8899

Please sign in to comment.