Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

Page Properties
idAPI_Specification

Link

Посилання на Apiary або Swagger

Resource

Посилання на ресурс, наприклад: /api/persons/create

Scope

rule_engine_rule:write

Scope для доступу

Components

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

Метод є синхронним чи асинхронним?

Public/Private/Internal

Потрібно зазначити тип методу за ступенем доступності

Expand
titleRequest example
Code Block
"""
Input for `createRuleEngineRule` mutation.

User must have a scope **rule_engine_rule:write**
"""
input CreateRuleEngineRuleInput {
  "Signed data to create rule engine set"
  signedContent: SignedContent!
}

"""
Return type for `createRuleEngineRule` mutation.
"""
type CreateRuleEngineRulePayload {
  "Created `RuleEngineRule`."
  ruleEngineRule: RuleEngineRule
}

...