Skip to content

Commit

Permalink
Integration des modifications proposées pour E-intervention Lot 2:
Browse files Browse the repository at this point in the history 
Conversion du swagger Lot1 en format OAS3
Conversion des documents fournis par BYTEL en format OAS3 .yaml
Intégration à la page web
  • Loading branch information
@f-teyssier
f-teyssier committed Dec 2, 2024
1 parent 6966e09 commit 3999964
Show file tree
Hide file tree
Showing 28 changed files with 9,686 additions and 0 deletions.
689 changes: 689 additions & 0 deletions E-Intervention-DO-v2.0.0.OAS3.yaml
View file

Large diffs are not rendered by default.

959 changes: 959 additions & 0 deletions E-Intervention-OI-v2.0.0.OAS3.yaml
View file

Large diffs are not rendered by default.

360 changes: 360 additions & 0 deletions E-Intervention-v1.0.0.OAS3.yaml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,360 @@
openapi: 3.0.0
info:
description: "Spécification des ressources qui devront être exposées par les différents acteurs impliqués par le protocole E-Intervention."
version: "1.0.0"
title: "E-Intervention"
servers:
- url: https://{serverRoot}/v1
variables:
serverRoot:
default: serverRoot
tags:
- name: client
description: "Opérations liées aux clients"
- name: intervention
description: "Opérations liées aux interventions"
paths:
/client_HS_OC_Par_Inter:
post:
tags:
- client
summary: "Flux 3 - Flux de déclaration des lignes impactées des OC vers l’OI (facultatif)"
description: "Opération permettant à l'opérateur commercial de déclarer des clients HS auprès de l'OI"
operationId: notifier_Clients_HS_OC
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/client_HS_OC_Par_Inter'
responses:
'200':
description: "Successful operation"
content:
application/json:
schema:
$ref: '#/components/schemas/reponse_Client_HS_OC_Par_Inter'
'400':
description: "Bad request"
content:
application/json:
schema:
$ref: '#/components/schemas/reponse_Client_HS_OC_Par_Inter'
'401':
description: "Unauthorized"
'403':
description: "Forbidden"
'404':
description: "Not found"
content:
application/json:
schema:
$ref: '#/components/schemas/reponse_Client_HS_OC_Par_Inter'
'405':
description: "Method Not Allowed"
'500':
description: "Internal Server Error"
security:
- api_auth:
- write:clients
/intervention_DO:
post:
tags:
- intervention
summary: "Flux 1 - Flux de déclaration d’intervention du DO vers l’OI"
description: "Opération permettant au DO de créer et mettre à jour une intervention chez l’OI"
operationId: declarer_Intervention_DO
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/intervention_DO'
responses:
'200':
description: "Successful operation"
content:
application/json:
schema:
$ref: '#/components/schemas/reponse_Intervention_DO'
'400':
description: "Bad request"
content:
application/json:
schema:
$ref: '#/components/schemas/reponse_Intervention_DO'
'401':
description: "Unauthorized"
'403':
description: "Forbidden"
'404':
description: "Not found"
content:
application/json:
schema:
$ref: '#/components/schemas/reponse_Intervention_DO'
'405':
description: "Method Not Allowed"
'500':
description: "Internal Server Error"
security:
- api_auth:
- write:interventions
/intervention_OI:
post:
tags:
- intervention
summary: "Flux 2 - Flux de déclaration d’intervention de l’OI vers les OC présents sur le PM"
description: "Opération permettant à l'OI de créer et mettre à jour une intervention chez l’OC"
operationId: declarer_Intervention_OI
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/intervention_OI'
responses:
'200':
description: "Successful operation"
content:
application/json:
schema:
$ref: '#/components/schemas/reponse_Intervention_OI'
'400':
description: "Bad request"
content:
application/json:
schema:
$ref: '#/components/schemas/reponse_Intervention_OI'
'401':
description: "Unauthorized"
'403':
description: "Forbidden"
'404':
description: "Not found"
content:
application/json:
schema:
$ref: '#/components/schemas/reponse_Intervention_OI'
'405':
description: "Method Not Allowed"
'500':
description: "Internal Server Error"
security:
- api_auth:
- write:interventions
components:
securitySchemes:
api_auth:
type: oauth2
flows:
implicit:
authorizationUrl: https://{serverRoot}/oauth/dialog
scopes:
write:clients: "Ecrire des infos clients"
write:interventions: "Ecrire des infos interventions"
schemas:
client_HS_OC_Par_Inter:
type: object
required:
- Code_OC_impacte
- Ref_Interv_OI
properties:
Code_OC_impacte:
type: string
maxLength: 4
description: "Code opérateur Interop de celui ayant des clients impactés\n"
Ref_Interv_OI:
type: string
maxLength: 50
description: "Référence d’intervention unique produite par l'OI\n"
Liste_Clients_HS:
type: array
items:
$ref: '#/components/schemas/client_HS_OC'
client_HS_OC:
type: object
description: "Conditionnel : au moins 1 client KO Liste des routes optiques de chaque client HS au PM dont l'heure de coupure est comprise dans l'intervalle\n"
required:
- PTO
- PBO
- Tube
- Fibre
- Position_PM_Module_OI
- HMS_Coupure
properties:
PTO:
type: string
maxLength: 50
PBO:
type: string
maxLength: 100
Tube:
type: string
maxLength: 50
Fibre:
type: string
maxLength: 50
Position_PM_Module_OI:
type: string
maxLength: 100
HMS_Coupure:
type: string
format: date-time
description: "Date/heure de début de coupure pour le client (format selon la norme ISO 8601)\n"
intervention_DO:
type: object
required:
- Code_DO
- Code_OI
- Ref_Interv_DO
- PM
- Nature_PBO_PTO
- Debut_Inter
properties:
Code_DO:
type: string
maxLength: 4
description: "Code opérateur Interop du donneur d'ordre\n"
Code_OI:
type: string
maxLength: 4
description: "Code opérateur Interop de l'opérateur d'infrastructure\n"
Ref_Interv_DO:
type: string
maxLength: 50
description: "Référence d'intervention unique produite par le donneur d'ordre et identique sur M1 et M3\n"
PM:
type: string
maxLength: 50
description: "Référence réglementaire du PM (ex: FI-XXXXX-XXXX)\n"
Nature_PBO_PTO:
type: array
items:
$ref: '#/components/schemas/nature_PBO_PTO'
Debut_Inter:
type: string
format: date-time
description: "Date/heure de début réel d'intervention (format selon la norme ISO 8601)\n"
Fin_Inter:
type: string
format: date-time
description: "Valeur NULL si M1 Date/heure de fin réel d'intervention si M3 (format selon la norme ISO 8601)\n"
intervention_OI:
type: object
required:
- Code_OI
- Ref_Interv_OI
- PM
- Debut_Inter
properties:
Code_OI:
type: string
maxLength: 4
description: "Code opérateur Interop de l'opérateur d'infrastructure\n"
Ref_Interv_OI:
type: string
maxLength: 50
description: "Référence d’intervention unique produite par l’OI dans R M1/R M3\n"
PM:
type: string
maxLength: 50
description: "Référence réglementaire du PM (ex: FI-XXXXX-XXXX)\n"
PBO:
type: array
items:
$ref: '#/components/schemas/PBO'
Debut_Inter:
type: string
format: date-time
description: "Date/heure de début réel d'intervention (format selon la norme ISO 8601)\n"
Fin_Inter:
type: string
format: date-time
description: "Valeur NULL si M2 Date/heure de fin réel d'intervention si M4 (format selon la norme ISO 8601)\n"
nature_PBO_PTO:
type: object
required:
- nature
properties:
nature:
type: integer
format: int32
enum: [1, 2, 3, 4]
description: "Nature finale de l'intervention, valeurs possibles : 1 = RACC 2 = SAV 3 = AUCUNE ACTION 4 = NON FOURNIE (valeur possible permettant de rendre facultatif la fourniture de l'information)\n"
PBO:
type: string
maxLength: 100
description: "Référence PBO (Ex: PTXXXXXXX) si disponible\n"
PTO:
type: string
maxLength: 50
description: "Référence PTO (Ex: FI-YYYY-YYYY) si disponible\n"
PBO:
type: object
properties:
PBO:
type: string
maxLength: 100
description: "Référence du PBO (ex: PTXXXXXXX) si fourni par le DO\n"
reponse_Client_HS_OC_Par_Inter:
type: object
required:
- Code_Reponse
- Libelle_Reponse
properties:
Code_Reponse:
type: integer
format: int32
enum: [0, 1, 2, 3]
description: "0 si OK 1 si CHAMPS_NON_RENSEIGNE 2 si MAUVAIS_FORMAT 3 si REF_INTERV_OI_INCONNUE\n"
Libelle_Reponse:
type: string
enum: ["OK", "CHAMPS_NON_RENSEIGNE", "MAUVAIS_FORMAT", "REF_INTERV_OI_INCONNUE"]
Description_Reponse:
type: string
maxLength: 100
description: "Description de l'erreur"
reponse_Intervention_DO:
type: object
required:
- Code_Reponse
- Libelle_Reponse
properties:
Code_Reponse:
type: integer
format: int32
enum: [0, 1, 2, 3, 4]
description: "0 si OK 1 si CHAMPS_NON_RENSEIGNE 2 si MAUVAIS_FORMAT 3 si CODE_OI_INCONNU 4 si PM_INCONNU\n"
Libelle_Reponse:
type: string
enum: ["OK", "CHAMPS_NON_RENSEIGNE", "MAUVAIS_FORMAT", "CODE_OI_INCONNU", "PM_INCONNU"]
Description_Reponse:
type: string
maxLength: 100
description: "Description de l'erreur"
Ref_Interv_OI:
type: string
maxLength: 50
description: "Conditionnel: si Libelle_Reponse = OK Référence d'intervention unique produite par l'opérateur d'infrastructure\n"
reponse_Intervention_OI:
type: object
required:
- Code_Reponse
- Libelle_Reponse
properties:
Code_Reponse:
type: integer
format: int32
enum: [0, 1, 2, 3, 4]
description: "0 si OK 1 si CHAMPS_NON_RENSEIGNE 2 si MAUVAIS_FORMAT 3 si CODE_OI_INCONNU 4 si PM_INCONNU\n"
Description_Reponse:
type: string
maxLength: 100
description: "Description de l'erreur"
Libelle_Reponse:
type: string
enum: ["OK", "CHAMPS_NON_RENSEIGNE", "MAUVAIS_FORMAT", "CODE_OI_INCONNU", "PM_INCONNU"]
externalDocs:
description: "Groupe Interop'Fibre"
url: "https://www.interop-fibre.fr/"
Loading

0 comments on commit 3999964

Please sign in to comment.