Skip to content

Commit

Permalink
Don't include Model keyword
Browse files Browse the repository at this point in the history
  • Loading branch information
AntoineAugusti committed Oct 3, 2018
1 parent 607ae3c commit f52227b
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -53,7 +53,7 @@ components:

The package will produce a Markdown file from the YAML specification file with the following content:
```markdown
## ResultatHumain Model
## ResultatHumain
|Field|Type|Description|Example|Properties|
|---|---|---|---|---|
|operation_id|integer($int64)|Le numéro unique de l'opération|1119920371||
Expand All @@ -64,7 +64,7 @@ The package will produce a Markdown file from the YAML specification file with t
```

And if you render it:
## ResultatHumain Model
## ResultatHumain
|Field|Type|Description|Example|Properties|
|---|---|---|---|---|
|operation_id|integer($int64)|Le numéro unique de l'opération|1119920371||
Expand Down
2 changes: 1 addition & 1 deletion open_api_schemas_to_markdown/converter.py
Expand Up @@ -46,7 +46,7 @@ def __init__(self, object_name, values, locale):

def format(self):
res = [
'## {name} Model'.format(name=self.object_name),
'## {name}'.format(name=self.object_name),
self.table_header(),
'|---|---|---|---|---|'
]
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Expand Up @@ -4,7 +4,7 @@
name='open_api_schemas_to_markdown',
license='MIT',
packages=['open_api_schemas_to_markdown'],
version='0.2.1',
version='0.3',
description='Generate Markdown documentation from OpenAPI 3 Components Schemas',
author='Antoine Augusti',
author_email='hi@antoine-augusti.fr',
Expand Down
8 changes: 4 additions & 4 deletions tests/files/expected_full_example.md
@@ -1,4 +1,4 @@
## Operation Model
## Operation
|Field|Type|Description|Example|Properties|
|---|---|---|---|---|
|operation_id|integer($int64)|Le numéro unique de l'opération|1119920371||
Expand All @@ -24,15 +24,15 @@
|numero_sitrep|integer($int32)|Numéro de situation report. Les numéros de SITREP sont remis à 0 tous les ans au 1er janvier 0h heure UTC et est incrémentale par la suite. La numérotation des SITREP est idépendante par les CROSS.||minimum: 1|
|cross_sitrep|string|Numéro unique identifiant l'opération utilisant le CROSS coordinateur de l'opération et le numéro de SITREP|Corsen 2017/42||
|fuseau_horaire|string|Fuseau horaire du CROSS coordonnant l'opération. Le fuseau horaire correspond à la timezone database de l'IANA|Europe/Paris||
## ResultatHumain Model
## ResultatHumain
|Field|Type|Description|Example|Properties|
|---|---|---|---|---|
|operation_id|integer($int64)|Le numéro unique de l'opération|1119920371||
|categorie_personne|string|Indique la catégorie de personne impliquée dans le bilan humain|Pêcheur français||
|resultat_humain|string|Description du bilan humain|Personne secourue||
|nombre|number($int32)|Nombre de personnes impliquées dans ce bilan|3|minimum: 0|
|dont_nombre_blesse|number($int32)|Indique le nombre de personnes blessées dans le bilan|1|minimum: 0|
## Moyen Model
## Moyen
|Field|Type|Description|Example|Properties|
|---|---|---|---|---|
|operation_id|integer($int64)|Le numéro unique de l'opération|1119920371||
Expand All @@ -43,7 +43,7 @@
|autorite_moyen|string|Autorité de rattachement du moyen mis en oeuvre|Gendarmerie Nationale||
|date_heure_debut|string($date-time)|Date et heure de mise en oeuvre du moyen en UTC au format ISO8601|1992-12-06T15:07:00Z||
|date_heure_fin|string($date-time)|Date et heure de fin de mise en oeuvre du moyen en UTC au format ISO8601|1992-12-06T15:07:00Z||
## Flotteur Model
## Flotteur
|Field|Type|Description|Example|Properties|
|---|---|---|---|---|
|operation_id|integer($int64)|Le numéro unique de l'opération|1119920371||
Expand Down
2 changes: 1 addition & 1 deletion tests/files/expected_simple_config.md
@@ -1,4 +1,4 @@
## ResultatHumain Model
## ResultatHumain
|Field|Type|Description|Example|Properties|
|---|---|---|---|---|
|operation_id|integer($int64)|Le numéro unique de l'opération|1119920371||
Expand Down
2 changes: 1 addition & 1 deletion tests/files/expected_simple_config_fr.md
@@ -1,4 +1,4 @@
## ResultatHumain Model
## ResultatHumain
|Colonne|Type|Description|Exemple|Propriétés|
|---|---|---|---|---|
|operation_id|integer($int64)|Le numéro unique de l'opération|1119920371||
Expand Down

0 comments on commit f52227b

Please sign in to comment.