Logo de publicodes Publicodes

openapi

API / @publicodes/rest-api / openapi

const openapi: object = openapiJson;

Type declaration

NameTypeDefault valueDefined in
componentsobject-openapi.codegen.json:8
components.schemasobject-openapi.codegen.json:9
components.schemas.EvaluateBodyobject-openapi.codegen.json:48
components.schemas.EvaluateBody.propertiesobject-openapi.codegen.json:53
components.schemas.EvaluateBody.properties.expressionsobject-openapi.codegen.json:54
components.schemas.EvaluateBody.properties.expressions.$refstring”#/components/schemas/Expressions”openapi.codegen.json:55
components.schemas.EvaluateBody.properties.situationobject-openapi.codegen.json:57
components.schemas.EvaluateBody.properties.situation.$refstring”#/components/schemas/Situation”openapi.codegen.json:58
components.schemas.EvaluateBody.requiredstring[]-openapi.codegen.json:50
components.schemas.EvaluateBody.typestring“object”openapi.codegen.json:49
components.schemas.EvaluateResponseobject-openapi.codegen.json:62
components.schemas.EvaluateResponse.descriptionstring“Schéma retourné par l’endpoint evaluate”openapi.codegen.json:63
components.schemas.EvaluateResponse.oneOf(object | object | object)[]-openapi.codegen.json:64
components.schemas.Expressionsobject-openapi.codegen.json:10
components.schemas.Expressions.descriptionstring“Une expression ou un tableau d’expressions Publicodes”openapi.codegen.json:11
components.schemas.Expressions.oneOf(object | object)[]-openapi.codegen.json:12
components.schemas.InputValidationErrorobject-openapi.codegen.json:141
components.schemas.InputValidationError.itemsobject-openapi.codegen.json:143
components.schemas.InputValidationError.items.propertiesobject-openapi.codegen.json:145
components.schemas.InputValidationError.items.properties.dataPathobject-openapi.codegen.json:149
components.schemas.InputValidationError.items.properties.dataPath.typestring“string”openapi.codegen.json:150
components.schemas.InputValidationError.items.properties.keywordobject-openapi.codegen.json:146
components.schemas.InputValidationError.items.properties.keyword.typestring“string”openapi.codegen.json:147
components.schemas.InputValidationError.items.properties.messageobject-openapi.codegen.json:155
components.schemas.InputValidationError.items.properties.message.typestring“string”openapi.codegen.json:156
components.schemas.InputValidationError.items.properties.paramsobject-openapi.codegen.json:158
components.schemas.InputValidationError.items.properties.params.additionalPropertiesobject-openapi.codegen.json:160
components.schemas.InputValidationError.items.properties.params.additionalProperties.typestring“string”openapi.codegen.json:161
components.schemas.InputValidationError.items.properties.params.typestring“object”openapi.codegen.json:159
components.schemas.InputValidationError.items.properties.schemaPathobject-openapi.codegen.json:152
components.schemas.InputValidationError.items.properties.schemaPath.typestring“string”openapi.codegen.json:153
components.schemas.InputValidationError.items.typestring“object”openapi.codegen.json:144
components.schemas.InputValidationError.typestring“array”openapi.codegen.json:142
components.schemas.PublicodesExpressionobject-openapi.codegen.json:32
components.schemas.PublicodesExpression.descriptionstring“Une expression Publicodes”openapi.codegen.json:33
components.schemas.PublicodesExpression.oneOf(object | object)[]-openapi.codegen.json:34
components.schemas.Ruleobject-openapi.codegen.json:167
components.schemas.Rule.propertiesobject-openapi.codegen.json:169
components.schemas.Rule.properties.nodeKindobject-openapi.codegen.json:173
components.schemas.Rule.properties.nodeKind.typestring“string”openapi.codegen.json:174
components.schemas.Rule.properties.rawNodeobject-openapi.codegen.json:176
components.schemas.Rule.properties.rawNode.additionalPropertiesobject-openapi.codegen.json:183
components.schemas.Rule.properties.rawNode.additionalProperties.typestring“object”openapi.codegen.json:184
components.schemas.Rule.properties.rawNode.propertiesobject-openapi.codegen.json:178
components.schemas.Rule.properties.rawNode.properties.questionobject-openapi.codegen.json:179
components.schemas.Rule.properties.rawNode.properties.question.typestring“string”openapi.codegen.json:180
components.schemas.Rule.properties.rawNode.typestring“object”openapi.codegen.json:177
components.schemas.Rule.properties.replacementsobject-openapi.codegen.json:187
components.schemas.Rule.properties.replacements.itemsobject-openapi.codegen.json:189
components.schemas.Rule.properties.replacements.items.typestring“object”openapi.codegen.json:190
components.schemas.Rule.properties.replacements.typestring“array”openapi.codegen.json:188
components.schemas.Rule.properties.suggestionsobject-openapi.codegen.json:193
components.schemas.Rule.properties.suggestions.typestring“object”openapi.codegen.json:194
components.schemas.Rule.properties.titleobject-openapi.codegen.json:170
components.schemas.Rule.properties.title.typestring“string”openapi.codegen.json:171
components.schemas.Rule.typestring“object”openapi.codegen.json:168
components.schemas.Rulesobject-openapi.codegen.json:198
components.schemas.Rules.additionalPropertiesobject-openapi.codegen.json:200
components.schemas.Rules.additionalProperties.$refstring”#/components/schemas/Rule”openapi.codegen.json:201
components.schemas.Rules.typestring“object”openapi.codegen.json:199
components.schemas.Situationobject-openapi.codegen.json:25
components.schemas.Situation.additionalPropertiesobject-openapi.codegen.json:28
components.schemas.Situation.additionalProperties.$refstring”#/components/schemas/PublicodesExpression”openapi.codegen.json:29
components.schemas.Situation.descriptionstring“La situation avec laquelle l’expression ou les expressions seront évaluées”openapi.codegen.json:26
components.schemas.Situation.typestring“object”openapi.codegen.json:27
infoobject-openapi.codegen.json:3
info.descriptionstring“Cet API expose vos règles Publicodes.”openapi.codegen.json:6
info.titlestring“Publicode API”openapi.codegen.json:4
info.versionstring“1.0.0-beta.41”openapi.codegen.json:5
openapistring“3.0.0”openapi.codegen.json:2
pathsobject-openapi.codegen.json:206
paths./evaluateobject-openapi.codegen.json:207
paths./evaluate.postobject-openapi.codegen.json:208
paths./evaluate.post.operationIdstring“evaluate”openapi.codegen.json:212
paths./evaluate.post.requestBodyobject-openapi.codegen.json:214
paths./evaluate.post.requestBody.contentobject-openapi.codegen.json:216
paths./evaluate.post.requestBody.content.application/jsonobject-openapi.codegen.json:217
paths./evaluate.post.requestBody.content.application/json.schemaobject-openapi.codegen.json:218
paths./evaluate.post.requestBody.content.application/json.schema.$refstring”#/components/schemas/EvaluateBody”openapi.codegen.json:219
paths./evaluate.post.requestBody.requiredbooleantrueopenapi.codegen.json:215
paths./evaluate.post.responsesobject-openapi.codegen.json:224
paths./evaluate.post.responses.200object-openapi.codegen.json:225
paths./evaluate.post.responses.200.contentobject-openapi.codegen.json:227
paths./evaluate.post.responses.200.content.application/jsonobject-openapi.codegen.json:228
paths./evaluate.post.responses.200.content.application/json.schemaobject-openapi.codegen.json:229
paths./evaluate.post.responses.200.content.application/json.schema.$refstring”#/components/schemas/EvaluateResponse”openapi.codegen.json:230
paths./evaluate.post.responses.200.descriptionstring“La requête a réussi”openapi.codegen.json:226
paths./evaluate.post.responses.400object-openapi.codegen.json:235
paths./evaluate.post.responses.400.contentobject-openapi.codegen.json:237
paths./evaluate.post.responses.400.content.application/jsonobject-openapi.codegen.json:238
paths./evaluate.post.responses.400.content.application/json.schemaobject-openapi.codegen.json:239
paths./evaluate.post.responses.400.content.application/json.schema.$refstring”#/components/schemas/InputValidationError”openapi.codegen.json:240
paths./evaluate.post.responses.400.descriptionstring“Erreur de validation d’entrée”openapi.codegen.json:236
paths./evaluate.post.summarystring“Evalue une expression avec un situation donnée”openapi.codegen.json:213
paths./evaluate.post.tagsstring[]-openapi.codegen.json:209
paths./rulesobject-openapi.codegen.json:248
paths./rules.getobject-openapi.codegen.json:249
paths./rules.get.operationIdstring“rules”openapi.codegen.json:253
paths./rules.get.responsesobject-openapi.codegen.json:255
paths./rules.get.responses.200object-openapi.codegen.json:256
paths./rules.get.responses.200.contentobject-openapi.codegen.json:258
paths./rules.get.responses.200.content.application/jsonobject-openapi.codegen.json:259
paths./rules.get.responses.200.content.application/json.schemaobject-openapi.codegen.json:260
paths./rules.get.responses.200.content.application/json.schema.$refstring”#/components/schemas/Rules”openapi.codegen.json:261
paths./rules.get.responses.200.descriptionstring“La requête a réussi”openapi.codegen.json:257
paths./rules.get.responses.400object-openapi.codegen.json:266
paths./rules.get.responses.400.contentobject-openapi.codegen.json:268
paths./rules.get.responses.400.content.application/jsonobject-openapi.codegen.json:269
paths./rules.get.responses.400.content.application/json.schemaobject-openapi.codegen.json:270
paths./rules.get.responses.400.content.application/json.schema.$refstring”#/components/schemas/InputValidationError”openapi.codegen.json:271
paths./rules.get.responses.400.descriptionstring“Erreur de validation d’entrée”openapi.codegen.json:267
paths./rules.get.summarystring“Retourne toutes les règles”openapi.codegen.json:254
paths./rules.get.tagsstring[]-openapi.codegen.json:250
paths./rules/{rule}object-openapi.codegen.json:279
paths./rules/{rule}.getobject-openapi.codegen.json:280
paths./rules/{rule}.get.operationIdstring“rules-rule”openapi.codegen.json:284
paths./rules/{rule}.get.parametersobject[]-openapi.codegen.json:286
paths./rules/{rule}.get.responsesobject-openapi.codegen.json:297
paths./rules/{rule}.get.responses.200object-openapi.codegen.json:298
paths./rules/{rule}.get.responses.200.contentobject-openapi.codegen.json:300
paths./rules/{rule}.get.responses.200.content.application/jsonobject-openapi.codegen.json:301
paths./rules/{rule}.get.responses.200.content.application/json.schemaobject-openapi.codegen.json:302
paths./rules/{rule}.get.responses.200.content.application/json.schema.oneOf(… | …)[]-openapi.codegen.json:303
paths./rules/{rule}.get.responses.200.descriptionstring“La requête a réussi”openapi.codegen.json:299
paths./rules/{rule}.get.responses.400object-openapi.codegen.json:325
paths./rules/{rule}.get.responses.400.contentobject-openapi.codegen.json:327
paths./rules/{rule}.get.responses.400.content.application/jsonobject-openapi.codegen.json:328
paths./rules/{rule}.get.responses.400.content.application/json.schemaobject-openapi.codegen.json:329
paths./rules/{rule}.get.responses.400.content.application/json.schema.$refstring”#/components/schemas/InputValidationError”openapi.codegen.json:330
paths./rules/{rule}.get.responses.400.descriptionstring“Erreur de validation d’entrée”openapi.codegen.json:326
paths./rules/{rule}.get.summarystring“Retourne la règle demandée”openapi.codegen.json:285
paths./rules/{rule}.get.tagsstring[]-openapi.codegen.json:281

Defined in

index.ts:7