[doc][release] 0.7.0

This commit is contained in:
Maxime Alves LIRMM 2023-02-03 12:43:30 +01:00
parent a3fc6dc830
commit 69129fd7af
3 changed files with 38 additions and 11 deletions

View File

@ -1,5 +1,10 @@
# HalfAPI # HalfAPI
## 0.7.0
- Uses the "Authorization" cookie to read authentication token additionnaly to the "Authorization" header
- CLI : allows to run a single domain using the "halfapi domain --run domain_name" command
## 0.6.23 ## 0.6.23
Dependency update version Dependency update version

View File

@ -23,17 +23,15 @@ to reference [HalfORM](https://github.com/collorg/halfORM), a project written by
Configure HalfAPI in the file : .halfapi/config . Configure HalfAPI in the file : .halfapi/config .
It's an **ini** file that contains at least two sections, project and domains. It's a **toml** file that contains at least two sections, project and domains.
https://toml.io/en/
### Project ### Project
The main configuration options without which HalfAPI cannot be run. The main configuration options without which HalfAPI cannot be run.
**name** : Project's name
**halfapi_version** : The HalfAPI version on which you work
**secret** : The file containing the secret to decode the user's tokens. **secret** : The file containing the secret to decode the user's tokens.
**port** : The port for the test server. **port** : The port for the test server.
@ -43,12 +41,28 @@ The main configuration options without which HalfAPI cannot be run.
### Domains ### Domains
The name of the options should be the name of the domains' module, the value is the Specify the domains configurations in the following form :
submodule which contains the routers.
Example : ```
[domains.DOMAIN_NAME]
name = "DOMAIN_NAME"
enabled = true
prefix = "/prefix"
module = "domain_name.path.to.api.root"
port = 1002
```
dummy_domain = .routers Specific configuration can be done under the "config" section :
```
[domains.DOMAIN_NAME.config]
boolean_option = false
string_value = "String"
answer = 42
listylist = ["hello", "world"]
```
And can be accessed through the app's "config" dictionnary.
## Usage ## Usage
@ -62,9 +76,17 @@ Run the project by using the `halfapi run` command.
You can try the dummy_domain with the following command. You can try the dummy_domain with the following command.
``` ```
python -m halfapi routes --export --noheader dummy_domain.routers | python -m halfapi run - PYTHONPATH=$PWD/tests python -m halfapi domain dummy_domain
``` ```
### CLI documentation
Use the CLI help.
```
python -m halfapi --help
python -m halfapi domain --help
```
## API Testing ## API Testing

View File

@ -1,5 +1,5 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
__version__ = '0.6.23' __version__ = '0.7.0'
def version(): def version():
return f'HalfAPI version:{__version__}' return f'HalfAPI version:{__version__}'