Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0.2.0 rc.1 #60

Merged
merged 3 commits into from
Jul 18, 2024
Merged

0.2.0 rc.1 #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
02bd2c6
v02.0-rc.1
FabrizioMoggio Jul 18, 2024
c5e73a9
Update README.md
FabrizioMoggio Jul 18, 2024
375bc65
Update CHANGELOG.md
FabrizioMoggio Jul 18, 2024
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
14 changes: 7 additions & 7 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@

## Table of Contents

- [v0.2.0-alpha.1](#v0.2.0-alpha.1)
- [v0.2.0-rc.1](#v0.2.0-rc.1)

# v0.2.0-alpha.1
# v0.2.0-rc.1

**This is the first alpha release of the CAMARA CallForwardingSignal API**

- API definition **with inline documentation**:
- OpenAPI [YAML spec file](https://github.com/camaraproject/CallForwardingSignal/blob/release-0.2.0-alpha.1/code/API_definitions/Call_Forwarding_Signal.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/release-0.2.0-alpha.1/code/API_definitions/Call_Forwarding_Signal.yaml&nocors)
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/release-0.2.0-alpha.1/code/API_definitions/Call_Forwarding_Signal.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/CallForwardingSignal/blob/release-0.2.0-rc.1/code/API_definitions/Call_Forwarding_Signal.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/release-0.2.0-rc.1/code/API_definitions/Call_Forwarding_Signal.yaml&nocors)
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/release-0.2.0-rc.1/code/API_definitions/Call_Forwarding_Signal.yaml)

## Please note:

- This is an alpha version, there are bug fixes to be expected and incompatible changes in upcoming versions
- The release is suitable for implementers, but it is not recommended to use the API with customers in productive environments
- Version numbers before v0.2.0-alpha.1 were used during the development of this version but not released
- Version numbers before v0.2.0-rc.1 were used during the development of this version but not released

## What's New

Expand All @@ -34,4 +34,4 @@
* @enlaichu
* @chinaunicomyangfan

**Full Changelog**: https://github.com/CallForwardingSignal/SimSwap/commits/v0.2.0-alpha.1
**Full Changelog**: https://github.com/CallForwardingSignal/CallForwardingSignal/commits/r1.1
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ Repository to describe, develop, document and test the Call Forwarding Signal AP
## Status and released versions

* Note: 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 a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
* **The latest available release and version of CAMARA CallForwardingSignal API is v0.2.0-Alpha.1. This is the first alpha version of the API.** There are bug fixes to be expected and incompatible changes in upcoming releases. It is suitable for implementors, but it is not recommended to use the API with customers in productive environments.
* Release v0.2.0-Alpha.1 of the API is available within the [release-0.2.0-alpha.1 branch](https://github.com/camaraproject/CallForwardingSignal/tree/release-0.2.0-alpha.1):
* **The latest available release and version of CAMARA CallForwardingSignal API is v0.2.0-rc.1. This is the first (pre) relese candidate version of the API.** There are bug fixes to be expected and incompatible changes in upcoming releases. It is suitable for implementors, but it is not recommended to use the API with customers in productive environments.
* Release v0.2.0-rc.1 of the API is available within the [release-0.2.0-rc.1 branch](https://github.com/camaraproject/CallForwardingSignal/tree/release-0.2.0-rc.1). The Release Tag is [r1.1](https://github.com/camaraproject/CallForwardingSignal/releases/tag/r1.1).
- API definition **with inline documentation**:
- OpenAPI [YAML spec file](https://github.com/camaraproject/CallForwardingSignal/blob/release-0.2.0-alpha.1/code/API_definitions/Call_Forwarding_Signal.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/release-0.2.0-alpha.1/code/API_definitions/Call_Forwarding_Signal.yaml&nocors)
- OpenAPI [YAML spec file](https://github.com/camaraproject/CallForwardingSignal/blob/release-0.2.0-rc.1/code/API_definitions/Call_Forwarding_Signal.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/release-0.2.0-rc.1/code/API_definitions/Call_Forwarding_Signal.yaml&nocors)
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/release-0.2.0-alpha.1/code/API_definitions/Call_Forwarding_Signal.yaml)
## Contributorship and mailing list
* To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit <https://lists.camaraproject.org/g/sp-cfs>.
Expand Down
15 changes: 9 additions & 6 deletions code/API_definitions/Call_Forwarding_Signal.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ openapi: 3.0.3
############################################################################
info:
title: Call Forwarding Signal API
version: 0.2.0-alpha.1
version: 0.2.0-rc.1
description: |
# Overview
The Call Forwarding Signal (CFS) API provides the API Consumer with
Expand Down Expand Up @@ -39,9 +39,10 @@ info:
CallForwarding\Signal/discussions/3#discussioncomment-8915595)
# Quick Start
The CFS API is a REST API based on the CreateCallForwardingSignal resource.
This resource is filled during the API invokation, by the API Consumer,
This resource can be filled during the API invokation, by the API Consumer,
with the phone number on which the Call Forwarding Service status must be
verified.\
verified. Anyway the phone number is also detected, by the API Producer,
from the access token.\
\
Before starting to use the Call Forwarding API, the developer needs to know
about the below specified details:\
Expand All @@ -51,9 +52,11 @@ info:
[**https://tim-api.developer.tim.it/callforwardingsignal**](https://tim-api\
.developer.tim.it/callforwarding\signal)\
\
**PhoneNumber**
**phoneNumber**
This is the end user phone number. The CFS API verifies if a call forwarding
service is active on this phone number.\
service is active on this phone number. Note: the value of this optional
parameter must match the value of the phone number retrieved from the access
token.\
\
**CreateCallForwardingSignal**
This is the resource the API Consumer uses to define the phone number to
Expand Down Expand Up @@ -156,7 +159,7 @@ externalDocs:
# Servers #
############################################################################
servers:
- url: "{apiRoot}/call-forwarding-signal/v0.2alpha1"
- url: "{apiRoot}/call-forwarding-signal/v0.2rc1"
variables:
apiRoot:
default: http://localhost:9091
Expand Down