Public API v1 tip kataloğu
Geliştirme · 0.0.0-dev
Yayın
- Doküman
- 0.0.0-dev
- Uygulama
- 0.0.0
Bu sayfa
- Uygulama
- 0.0.0
- Şema
- api-v1
Bu katalog public API’nin tam transitive tip closure’ını gösterir.
Manifest durumu contract_projection_not_deployed; bu contract tanımı tek başına deployment kanıtı değildir.
? nullable alanı, [] listeyi ifade eder. Required ve Nullable
birbirinden bağımsız okunmalıdır. Çağrı davranışı için
API sözleşmesine, operasyon eşlemesi için
RPC kataloğuna bakın.
Scalar tipler
Bölüm başlığı “Scalar tipler”| Contract tipi | TypeScript | Temel tip | Kısıt |
|---|---|---|---|
idempotency_key |
IdempotencyKey |
string |
min_length=16, max_length=200 |
locale |
Locale |
string |
pattern=^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$ |
opaque_cursor |
OpaqueCursor |
string |
min_length=1, max_length=8192 |
sha256 |
Sha256 |
string |
pattern=^[0-9a-f]{64}$ |
uuid |
UUID |
string |
format=uuid |
Enum tipler
Bölüm başlığı “Enum tipler”| Contract tipi | TypeScript | Değerler |
|---|---|---|
alignment_authority_status |
AlignmentAuthorityStatus |
accepted, unresolved |
alignment_group_shape |
AlignmentGroupShape |
complex, merge, one_to_one, split |
alignment_order_side |
AlignmentOrderSide |
source, target |
alignment_state |
AlignmentState |
mapped, unresolved_candidate, source_fallback, target_only |
annotation_kind |
AnnotationKind |
alignment, compound, heading, note, ottoman_rendering, repetition, segment |
curation_action |
CurationAction |
amend, create, invalidate_decision, relate, retire, set_lifecycle, supersede |
curation_decision |
CurationDecision |
accepted, rejected |
curation_proposal_kind |
CurationProposalKind |
compound.entry, compound.occurrence, compound.variant, lexeme, lexeme.form, lexeme.root_assertion, lexical.root, repetition.canonical_choice |
curation_proposal_state |
CurationProposalState |
submitted, under_review, accepted, rejected, applied, retired, superseded |
curation_review_decision |
CurationReviewDecision |
approve, reject |
heading_script_class |
HeadingScriptClass |
latin, arabic, mixed_arabic_latin, other |
hover_child_role |
HoverChildRole |
lexical, connector, function_tail |
hover_dictionary_state |
HoverDictionaryState |
direct_term, trusted_base, curated_root, missing |
hover_occurrence_mode |
HoverOccurrenceMode |
none, exact, semantic, root |
hover_occurrence_scope |
HoverOccurrenceScope |
none, token, compound |
hover_policy |
HoverPolicy |
show_base_dictionary, show_full_dictionary, show_counterpart_only |
hover_root_outcome |
HoverRootOutcome |
selected, not_applicable |
hover_semantic_kind |
HoverSemanticKind |
abbreviation, number_phrase, render_phrase, title_or_name, lexical_single, function_phrase, lexical_compound, unknown_compound, inflected_compound |
hover_sense_outcome |
HoverSenseOutcome |
selected, no_direct_sense |
hover_target_kind |
HoverTargetKind |
none, lexeme, compound_entry |
hover_term_kind |
HoverTermKind |
single, compound, abbreviation |
lifecycle_state |
LifecycleState |
active, rejected, retired, superseded |
note_mapping_status |
NoteMappingStatus |
mapped, source_gap |
note_type |
NoteType |
formal_hasiye, starred_note |
ottoman_reader_status |
OttomanReaderStatus |
canonical, source_arabic, passthrough, machine_fallback |
provenance_public_subject_kind |
ProvenancePublicSubjectKind |
entity, release |
reference_kind |
ReferenceKind |
alignment_group, alignment_unit, book, chapter, compound_entry, compound_occurrence, compound_variant, dictionary_entry, dictionary_sense, exact_class, heading, lexeme, lexeme_form, lexical_root, note, orthographic_form, paragraph, passage_occurrence, rendering_occurrence, repeat_family, segment, sentence_occurrence, text_selection, text_span, text_version, token_form, token_occurrence, work |
repetition_dominance_status |
RepetitionDominanceStatus |
structural_unit, maximal |
repetition_granularity |
RepetitionGranularity |
paragraph, sentence_sequence |
repetition_kind |
RepetitionKind |
exact_class, repeat_family |
repetition_membership_state |
RepetitionMembershipState |
accepted |
resolution_mode |
ResolutionMode |
exact, current |
resolution_state |
ResolutionState |
exact, current, ambiguous, retired, unavailable |
supersession_disposition |
SupersessionDisposition |
effective, invalidated |
supersession_event_kind |
SupersessionEventKind |
replacement, split, merge, restructure, retirement |
supersession_source_kind |
SupersessionSourceKind |
compound, lexeme |
token_occurrence_kind |
TokenOccurrenceKind |
form, literal |
Sözleşme union tipleri
Bölüm başlığı “Sözleşme union tipleri”| Contract tipi | TypeScript | Değerler |
|---|---|---|
operation_key |
OperationKey |
contract_capabilities_get, chapter_core_get, chapter_alignment_units_list, chapter_headings_get, chapter_ottoman_get, chapter_hover_get, chapter_notes_get, chapter_repetitions_get, entity_exact_get, entity_current_resolve, entity_occurrences_list, repetition_members_list, alignment_targets_list, annotations_list, public_provenance_get, curation_proposal_get, curation_proposal_submit, curation_review_record, curation_decision_record, curation_decision_apply |
result_state |
ResultState |
available, empty, pending, unavailable, ambiguous, retired |
error_code |
ErrorCode |
invalid_request, unauthenticated, not_found_or_forbidden, unsupported_contract, conflict, continuation_invalid, response_budget_exceeded, rate_limited, integrity_failure, service_unavailable, timeout |
Request ve response tipleri
Bölüm başlığı “Request ve response tipleri”ContractCapabilitiesRequest
Bölüm başlığı “ContractCapabilitiesRequest”Kullanım: contract_capabilities_get:request.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
requested_deployment_id |
uuid? |
Hayır | Evet |
ContractCapabilities
Bölüm başlığı “ContractCapabilities”Kullanım: contract_capabilities_get:response.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
supported_majors |
integer[] |
Evet | Hayır |
contract_releases |
api.contract_release_summary[] |
Evet | Hayır |
active_deployment |
api.deployment_summary |
Evet | Hayır |
ChapterCoreRequest
Bölüm başlığı “ChapterCoreRequest”Kullanım: chapter_core_get:request.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
chapter_id |
uuid |
Evet | Hayır |
deployment_id |
uuid? |
Hayır | Evet |
ChapterCoreProjection
Bölüm başlığı “ChapterCoreProjection”Kullanım: chapter_core_get:response.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
chapter |
public.chapter |
Evet | Hayır |
paragraphs |
public.paragraph[] |
Evet | Hayır |
sentences |
public.sentence[] |
Evet | Hayır |
token_occurrences |
public.token_occurrence[] |
Evet | Hayır |
reconstruction_root |
sha256 |
Evet | Hayır |
ChapterAlignmentUnitsRequest
Bölüm başlığı “ChapterAlignmentUnitsRequest”Kullanım: chapter_alignment_units_list:request.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
chapter_id |
uuid |
Evet | Hayır |
target_locale |
locale |
Evet | Hayır |
order_side |
alignment_order_side |
Evet | Hayır |
cursor |
opaque_cursor? |
Hayır | Evet |
page_size |
integer? |
Hayır | Evet |
deployment_id |
uuid? |
Hayır | Evet |
ChapterAlignmentItem
Bölüm başlığı “ChapterAlignmentItem”Kullanım: chapter_alignment_units_list:response. Closed variant: chapter_alignment_mapping_status_v1.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
alignment_item_id |
uuid |
Evet | Hayır |
alignment_group_id |
uuid? |
Evet | Evet |
chapter_id |
uuid |
Evet | Hayır |
source_text_version_id |
uuid |
Evet | Hayır |
target_text_version_id |
uuid |
Evet | Hayır |
source_language_tag |
locale |
Evet | Hayır |
target_language_tag |
locale |
Evet | Hayır |
order_side |
alignment_order_side |
Evet | Hayır |
reader_position |
integer |
Evet | Hayır |
accepted_order_position |
integer? |
Evet | Evet |
authority_status |
alignment_authority_status |
Evet | Hayır |
mapping_status |
alignment_state |
Evet | Hayır |
group_shape |
alignment_group_shape? |
Evet | Evet |
order_status |
string |
Evet | Hayır |
source_units |
public.alignment_source_unit[] |
Evet | Hayır |
target_units |
public.alignment_target_unit[] |
Evet | Hayır |
ChapterHeadingsRequest
Bölüm başlığı “ChapterHeadingsRequest”Kullanım: chapter_headings_get:request.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
chapter_id |
uuid |
Evet | Hayır |
deployment_id |
uuid? |
Hayır | Evet |
ChapterHeadingsProjection
Bölüm başlığı “ChapterHeadingsProjection”Kullanım: chapter_headings_get:response.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
chapter_id |
uuid |
Evet | Hayır |
core_release_id |
uuid |
Evet | Hayır |
heading_release_id |
uuid |
Evet | Hayır |
headings |
public.heading[] |
Evet | Hayır |
ChapterOttomanRequest
Bölüm başlığı “ChapterOttomanRequest”Kullanım: chapter_ottoman_get:request.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
chapter_id |
uuid |
Evet | Hayır |
deployment_id |
uuid? |
Hayır | Evet |
ChapterOttomanProjection
Bölüm başlığı “ChapterOttomanProjection”Kullanım: chapter_ottoman_get:response.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
chapter_id |
uuid |
Evet | Hayır |
core_release_id |
uuid |
Evet | Hayır |
ottoman_reader_release_id |
uuid |
Evet | Hayır |
units |
public.ottoman_reader_unit[] |
Evet | Hayır |
reconstruction_root |
sha256 |
Evet | Hayır |
ChapterHoverRequest
Bölüm başlığı “ChapterHoverRequest”Kullanım: chapter_hover_get:request.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
chapter_id |
uuid |
Evet | Hayır |
deployment_id |
uuid? |
Hayır | Evet |
ChapterHoverProjection
Bölüm başlığı “ChapterHoverProjection”Kullanım: chapter_hover_get:response.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
chapter_id |
uuid |
Evet | Hayır |
core_release_id |
uuid |
Evet | Hayır |
ottoman_reader_release_id |
uuid |
Evet | Hayır |
lexical_release_id |
uuid |
Evet | Hayır |
bindings |
public.hover_binding[] |
Evet | Hayır |
children |
public.hover_child[] |
Evet | Hayır |
ChapterNotesRequest
Bölüm başlığı “ChapterNotesRequest”Kullanım: chapter_notes_get:request.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
chapter_id |
uuid |
Evet | Hayır |
deployment_id |
uuid? |
Hayır | Evet |
ChapterNotesProjection
Bölüm başlığı “ChapterNotesProjection”Kullanım: chapter_notes_get:response.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
chapter_id |
uuid |
Evet | Hayır |
core_release_id |
uuid |
Evet | Hayır |
note_release_id |
uuid |
Evet | Hayır |
notes |
public.chapter_note[] |
Evet | Hayır |
ChapterRepetitionsRequest
Bölüm başlığı “ChapterRepetitionsRequest”Kullanım: chapter_repetitions_get:request.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
chapter_id |
uuid |
Evet | Hayır |
deployment_id |
uuid? |
Hayır | Evet |
ChapterRepetitionsProjection
Bölüm başlığı “ChapterRepetitionsProjection”Kullanım: chapter_repetitions_get:response.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
chapter_id |
uuid |
Evet | Hayır |
core_release_id |
uuid |
Evet | Hayır |
repetition_release_id |
uuid |
Evet | Hayır |
repetitions |
public.chapter_repetition[] |
Evet | Hayır |
EntityExactRequest
Bölüm başlığı “EntityExactRequest”Kullanım: entity_exact_get:request.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
entity_kind |
reference_kind |
Evet | Hayır |
entity_id |
uuid |
Evet | Hayır |
deployment_id |
uuid? |
Hayır | Evet |
EntityExactProjection
Bölüm başlığı “EntityExactProjection”Kullanım: entity_exact_get:response.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
entity_kind |
reference_kind |
Evet | Hayır |
entity_id |
uuid |
Evet | Hayır |
lifecycle |
public.lifecycle_summary |
Evet | Hayır |
projection |
public.entity_projection |
Evet | Hayır |
EntityCurrentRequest
Bölüm başlığı “EntityCurrentRequest”Kullanım: entity_current_resolve:request.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
entity_kind |
reference_kind |
Evet | Hayır |
entity_id |
uuid |
Evet | Hayır |
resolution_policy_id |
uuid |
Evet | Hayır |
deployment_id |
uuid? |
Hayır | Evet |
EntityResolution
Bölüm başlığı “EntityResolution”Kullanım: entity_current_resolve:response.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
source_entity_id |
uuid |
Evet | Hayır |
resolution_state |
resolution_state |
Evet | Hayır |
target_entity_ids |
uuid[] |
Evet | Hayır |
resolution_policy_id |
uuid |
Evet | Hayır |
resolution_release_id |
uuid |
Evet | Hayır |
path |
public.supersession_path_step[] |
Evet | Hayır |
lifecycle |
public.lifecycle_summary |
Evet | Hayır |
EntityOccurrencesRequest
Bölüm başlığı “EntityOccurrencesRequest”Kullanım: entity_occurrences_list:request.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
entity_kind |
reference_kind |
Evet | Hayır |
entity_id |
uuid |
Evet | Hayır |
resolution_mode |
resolution_mode |
Evet | Hayır |
cursor |
opaque_cursor? |
Hayır | Evet |
page_size |
integer? |
Hayır | Evet |
deployment_id |
uuid? |
Hayır | Evet |
EntityOccurrence
Bölüm başlığı “EntityOccurrence”Kullanım: entity_occurrences_list:response.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
occurrence_id |
uuid |
Evet | Hayır |
entity_id |
uuid |
Evet | Hayır |
sentence_id |
uuid |
Evet | Hayır |
span |
public.span_projection? |
Hayır | Evet |
context |
public.occurrence_context |
Evet | Hayır |
RepetitionMembersRequest
Bölüm başlığı “RepetitionMembersRequest”Kullanım: repetition_members_list:request.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
repetition_kind |
repetition_kind |
Evet | Hayır |
repetition_id |
uuid |
Evet | Hayır |
cursor |
opaque_cursor? |
Hayır | Evet |
page_size |
integer? |
Hayır | Evet |
deployment_id |
uuid? |
Hayır | Evet |
RepetitionMember
Bölüm başlığı “RepetitionMember”Kullanım: repetition_members_list:response.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
exact_class_id |
uuid |
Evet | Hayır |
passage_occurrence_id |
uuid |
Evet | Hayır |
selection_id |
uuid |
Evet | Hayır |
member_position |
integer |
Evet | Hayır |
member_count |
integer |
Evet | Hayır |
membership_state |
repetition_membership_state |
Evet | Hayır |
granularity |
repetition_granularity |
Evet | Hayır |
chapter_id |
uuid |
Evet | Hayır |
paragraph_id |
uuid? |
Hayır | Evet |
start_sentence_id |
uuid |
Evet | Hayır |
end_sentence_id |
uuid |
Evet | Hayır |
excerpt |
string |
Evet | Hayır |
AlignmentTargetsRequest
Bölüm başlığı “AlignmentTargetsRequest”Kullanım: alignment_targets_list:request.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
alignment_unit_id |
uuid |
Evet | Hayır |
target_locale |
locale |
Evet | Hayır |
cursor |
opaque_cursor? |
Hayır | Evet |
page_size |
integer? |
Hayır | Evet |
deployment_id |
uuid? |
Hayır | Evet |
AlignmentTarget
Bölüm başlığı “AlignmentTarget”Kullanım: alignment_targets_list:response.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
alignment_group_id |
uuid |
Evet | Hayır |
source_unit_id |
uuid |
Evet | Hayır |
target_unit_id |
uuid |
Evet | Hayır |
alignment_state |
alignment_state |
Evet | Hayır |
AnnotationsRequest
Bölüm başlığı “AnnotationsRequest”Kullanım: annotations_list:request.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
owner_entity_id |
uuid |
Evet | Hayır |
annotation_kinds |
annotation_kind[] |
Evet | Hayır |
cursor |
opaque_cursor? |
Hayır | Evet |
page_size |
integer? |
Hayır | Evet |
deployment_id |
uuid? |
Hayır | Evet |
AnnotationProjection
Bölüm başlığı “AnnotationProjection”Kullanım: annotations_list:response.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
annotation_kind |
annotation_kind |
Evet | Hayır |
annotation_id |
uuid |
Evet | Hayır |
owner_entity_id |
uuid |
Evet | Hayır |
span |
public.span_projection? |
Hayır | Evet |
projection |
public.annotation_projection_payload |
Evet | Hayır |
PublicProvenanceRequest
Bölüm başlığı “PublicProvenanceRequest”Kullanım: public_provenance_get:request.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
subject_kind |
provenance_public_subject_kind |
Evet | Hayır |
subject_id |
uuid |
Evet | Hayır |
deployment_id |
uuid? |
Hayır | Evet |
PublicProvenanceSummary
Bölüm başlığı “PublicProvenanceSummary”Kullanım: public_provenance_get:response.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
subject_kind |
provenance_public_subject_kind |
Evet | Hayır |
subject_id |
uuid |
Evet | Hayır |
source_summary |
public.provenance_source_summary |
Evet | Hayır |
transformation_summary |
public.provenance_transformation_summary |
Evet | Hayır |
release_summary |
public.provenance_release_summary |
Evet | Hayır |
CurationProposalRequest
Bölüm başlığı “CurationProposalRequest”Kullanım: curation_proposal_get:request.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
proposal_id |
uuid |
Evet | Hayır |
deployment_id |
uuid? |
Hayır | Evet |
CurationProposalSubmitRequest
Bölüm başlığı “CurationProposalSubmitRequest”Kullanım: curation_proposal_submit:request.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
proposal_kind |
curation_proposal_kind |
Evet | Hayır |
subject_id |
uuid |
Evet | Hayır |
expected_parent_revision_id |
uuid? |
Hayır | Evet |
payload |
public.curation_proposal_payload |
Evet | Hayır |
proposal_payload_root |
sha256 |
Evet | Hayır |
action_inventory_root |
sha256 |
Evet | Hayır |
target_inventory_root |
sha256 |
Evet | Hayır |
evidence_inventory_root |
sha256 |
Evet | Hayır |
expected_state_root |
sha256 |
Evet | Hayır |
authority_snapshot_root |
sha256 |
Evet | Hayır |
policy_root |
sha256 |
Evet | Hayır |
evidence_ids |
uuid[] |
Evet | Hayır |
idempotency_key |
idempotency_key |
Evet | Hayır |
CurationProposal
Bölüm başlığı “CurationProposal”Kullanım: curation_proposal_get:response, curation_proposal_submit:response.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
proposal_id |
uuid |
Evet | Hayır |
revision_id |
uuid |
Evet | Hayır |
state |
curation_proposal_state |
Evet | Hayır |
subject_id |
uuid |
Evet | Hayır |
payload_root |
sha256 |
Evet | Hayır |
evidence_root |
sha256 |
Evet | Hayır |
lifecycle |
public.lifecycle_summary |
Evet | Hayır |
CurationReviewRequest
Bölüm başlığı “CurationReviewRequest”Kullanım: curation_review_record:request.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
proposal_revision_id |
uuid |
Evet | Hayır |
proposal_payload_root |
sha256 |
Evet | Hayır |
review_decision |
curation_review_decision |
Evet | Hayır |
evidence_ids |
uuid[] |
Evet | Hayır |
idempotency_key |
idempotency_key |
Evet | Hayır |
CurationReviewReceipt
Bölüm başlığı “CurationReviewReceipt”Kullanım: curation_review_record:response.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
review_id |
uuid |
Evet | Hayır |
proposal_revision_id |
uuid |
Evet | Hayır |
review_decision |
curation_review_decision |
Evet | Hayır |
review_root |
sha256 |
Evet | Hayır |
CurationDecisionRequest
Bölüm başlığı “CurationDecisionRequest”Kullanım: curation_decision_record:request.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
proposal_revision_id |
uuid |
Evet | Hayır |
proposal_payload_root |
sha256 |
Evet | Hayır |
decision |
curation_decision |
Evet | Hayır |
review_ids |
uuid[] |
Evet | Hayır |
idempotency_key |
idempotency_key |
Evet | Hayır |
CurationDecisionReceipt
Bölüm başlığı “CurationDecisionReceipt”Kullanım: curation_decision_record:response.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
decision_id |
uuid |
Evet | Hayır |
proposal_revision_id |
uuid |
Evet | Hayır |
decision |
curation_decision |
Evet | Hayır |
decision_root |
sha256 |
Evet | Hayır |
CurationApplyRequest
Bölüm başlığı “CurationApplyRequest”Kullanım: curation_decision_apply:request.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
decision_id |
uuid |
Evet | Hayır |
decision_root |
sha256 |
Evet | Hayır |
expected_parent_id |
uuid |
Evet | Hayır |
expected_freeze_epoch |
integer |
Evet | Hayır |
idempotency_key |
idempotency_key |
Evet | Hayır |
CurationApplyReceipt
Bölüm başlığı “CurationApplyReceipt”Kullanım: curation_decision_apply:response.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
transaction_id |
uuid |
Evet | Hayır |
decision_id |
uuid |
Evet | Hayır |
release_id |
uuid |
Evet | Hayır |
event_id |
uuid |
Evet | Hayır |
effective_state_root |
sha256 |
Evet | Hayır |
Public projection ve envelope tipleri
Bölüm başlığı “Public projection ve envelope tipleri”api.contract_release_summary / ApiContractReleaseSummary
Bölüm başlığı “api.contract_release_summary / ApiContractReleaseSummary”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
api_contract_release_id |
uuid |
Evet | Hayır |
contract_id |
string |
Evet | Hayır |
major |
integer |
Evet | Hayır |
contract_root |
sha256 |
Evet | Hayır |
api.deployment_summary / ApiDeploymentSummary
Bölüm başlığı “api.deployment_summary / ApiDeploymentSummary”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
api_deployment_id |
uuid |
Evet | Hayır |
api_contract_release_id |
uuid |
Evet | Hayır |
data_release_set_root |
sha256 |
Evet | Hayır |
policy_release_set_root |
sha256 |
Evet | Hayır |
api.error / ApiError
Bölüm başlığı “api.error / ApiError”Public projection tipi. Kaynak alan seti: contract.envelopes.error.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
code |
error_code |
Evet | Hayır |
retryable |
boolean |
Evet | Hayır |
detail_code |
string? |
Evet | Evet |
retry_after_ms |
integer? |
Evet | Evet |
api.page / ApiPage
Bölüm başlığı “api.page / ApiPage”Public projection tipi. Kaynak alan seti: contract.envelopes.page.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
next_cursor |
opaque_cursor? |
Evet | Evet |
has_more |
boolean |
Evet | Hayır |
api.release_context / ApiReleaseContext
Bölüm başlığı “api.release_context / ApiReleaseContext”Public projection tipi. Kaynak alan seti: contract.release_context.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
api_deployment_id |
uuid |
Evet | Hayır |
api_contract_release_id |
uuid |
Evet | Hayır |
api_operation_revision_id |
uuid |
Evet | Hayır |
code_release_id |
uuid |
Evet | Hayır |
schema_release_id |
uuid |
Evet | Hayır |
data_release_set_root |
sha256 |
Evet | Hayır |
policy_release_set_root |
sha256 |
Evet | Hayır |
exposure_manifest_root |
sha256 |
Evet | Hayır |
api.state_context / ApiStateContext
Bölüm başlığı “api.state_context / ApiStateContext”Public projection tipi. Kaynak alan seti: contract.envelopes.state_context.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
reason_code |
string? |
Evet | Evet |
retry_after_ms |
integer? |
Evet | Evet |
status_resource_id |
uuid? |
Evet | Evet |
public.alignment_source_unit / AlignmentSourceUnit
Bölüm başlığı “public.alignment_source_unit / AlignmentSourceUnit”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
unit_id |
uuid |
Evet | Hayır |
sentence_id |
uuid |
Evet | Hayır |
span_id |
uuid? |
Hayır | Evet |
text |
string |
Evet | Hayır |
public.alignment_target_unit / AlignmentTargetUnit
Bölüm başlığı “public.alignment_target_unit / AlignmentTargetUnit”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
unit_id |
uuid |
Evet | Hayır |
book_id |
uuid |
Evet | Hayır |
text |
string |
Evet | Hayır |
public.annotation_projection_payload / AnnotationProjectionPayload
Bölüm başlığı “public.annotation_projection_payload / AnnotationProjectionPayload”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
status |
string |
Evet | Hayır |
label |
string? |
Hayır | Evet |
latin_text |
string? |
Hayır | Evet |
ottoman_text |
string? |
Hayır | Evet |
meaning |
string? |
Hayır | Evet |
root_text |
string? |
Hayır | Evet |
public.chapter / ChapterProjection
Bölüm başlığı “public.chapter / ChapterProjection”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
chapter_id |
uuid |
Evet | Hayır |
book_id |
uuid |
Evet | Hayır |
text_version_id |
uuid |
Evet | Hayır |
position |
integer |
Evet | Hayır |
initial_text |
string |
Evet | Hayır |
text_sha256 |
sha256 |
Evet | Hayır |
public.chapter_note / ChapterNoteProjection
Bölüm başlığı “public.chapter_note / ChapterNoteProjection”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
note_id |
uuid? |
Hayır | Evet |
note_type |
note_type |
Evet | Hayır |
mapping_status |
note_mapping_status |
Evet | Hayır |
markers |
public.note_marker[] |
Evet | Hayır |
bodies |
public.note_body[] |
Evet | Hayır |
marker_text |
string |
Evet | Hayır |
body_text |
string? |
Hayır | Evet |
public.chapter_repetition / ChapterRepetitionProjection
Bölüm başlığı “public.chapter_repetition / ChapterRepetitionProjection”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
annotation_id |
uuid |
Evet | Hayır |
exact_class_id |
uuid |
Evet | Hayır |
passage_occurrence_id |
uuid |
Evet | Hayır |
selection_id |
uuid |
Evet | Hayır |
granularity |
repetition_granularity |
Evet | Hayır |
dominance_status |
repetition_dominance_status |
Evet | Hayır |
member_count |
integer |
Evet | Hayır |
member_position |
integer |
Evet | Hayır |
start_sentence_id |
uuid |
Evet | Hayır |
end_sentence_id |
uuid |
Evet | Hayır |
spans |
public.repetition_span[] |
Evet | Hayır |
public.curation_proposal_payload / CurationProposalPayload
Bölüm başlığı “public.curation_proposal_payload / CurationProposalPayload”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
action |
curation_action |
Evet | Hayır |
target_kind |
reference_kind |
Evet | Hayır |
target_entity_ids |
uuid[] |
Evet | Hayır |
replacement_entity_ids |
uuid[] |
Evet | Hayır |
reason_code |
string |
Evet | Hayır |
public.entity_projection / EntityProjectionPayload
Bölüm başlığı “public.entity_projection / EntityProjectionPayload”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
entity_id |
uuid |
Evet | Hayır |
entity_kind |
reference_kind |
Evet | Hayır |
display_text |
string |
Evet | Hayır |
exact_text |
string? |
Hayır | Evet |
public.heading / HeadingProjection
Bölüm başlığı “public.heading / HeadingProjection”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
heading_id |
uuid |
Evet | Hayır |
parent_heading_id |
uuid? |
Hayır | Evet |
marker_span_id |
uuid |
Evet | Hayır |
chapter_id |
uuid |
Evet | Hayır |
sentence_id |
uuid |
Evet | Hayır |
position |
integer |
Evet | Hayır |
level |
integer |
Evet | Hayır |
depth |
integer |
Evet | Hayır |
start_scalar |
integer |
Evet | Hayır |
end_scalar |
integer |
Evet | Hayır |
text |
string |
Evet | Hayır |
script_class |
heading_script_class |
Evet | Hayır |
public.hover_binding / HoverBindingProjection
Bölüm başlığı “public.hover_binding / HoverBindingProjection”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
binding_id |
uuid |
Evet | Hayır |
unit_id |
uuid |
Evet | Hayır |
term_kind |
hover_term_kind |
Evet | Hayır |
semantic_kind |
hover_semantic_kind |
Evet | Hayır |
hover_policy |
hover_policy |
Evet | Hayır |
latin_text |
string |
Evet | Hayır |
ottoman_text |
string |
Evet | Hayır |
dictionary_state |
hover_dictionary_state |
Evet | Hayır |
meaning_text |
string? |
Hayır | Evet |
root_text |
string? |
Hayır | Evet |
occurrence_scope |
hover_occurrence_scope |
Evet | Hayır |
occurrence_mode |
hover_occurrence_mode |
Evet | Hayır |
target_kind |
hover_target_kind |
Evet | Hayır |
target_id |
uuid? |
Hayır | Evet |
public.hover_child / HoverChildProjection
Bölüm başlığı “public.hover_child / HoverChildProjection”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
binding_id |
uuid |
Evet | Hayır |
position |
integer |
Evet | Hayır |
first_occurrence_id |
uuid |
Evet | Hayır |
last_occurrence_id |
uuid |
Evet | Hayır |
latin_text |
string |
Evet | Hayır |
ottoman_text |
string |
Evet | Hayır |
semantic_kind |
hover_semantic_kind |
Evet | Hayır |
hover_policy |
hover_policy |
Evet | Hayır |
child_role |
hover_child_role |
Evet | Hayır |
is_tab |
boolean |
Evet | Hayır |
target_kind |
hover_target_kind |
Evet | Hayır |
target_id |
uuid? |
Hayır | Evet |
root_outcome |
hover_root_outcome? |
Hayır | Evet |
root_id |
uuid? |
Hayır | Evet |
root_text |
string? |
Hayır | Evet |
sense_outcome |
hover_sense_outcome? |
Hayır | Evet |
sense_id |
uuid? |
Hayır | Evet |
meaning_text |
string? |
Hayır | Evet |
public.lifecycle_summary / LifecycleSummary
Bölüm başlığı “public.lifecycle_summary / LifecycleSummary”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
state |
lifecycle_state |
Evet | Hayır |
effective_release_id |
uuid |
Evet | Hayır |
successor_ids |
uuid[] |
Evet | Hayır |
public.note_body / NoteBodyProjection
Bölüm başlığı “public.note_body / NoteBodyProjection”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
position |
integer |
Evet | Hayır |
selection_id |
uuid |
Evet | Hayır |
text |
string |
Evet | Hayır |
spans |
public.note_body_span[] |
Evet | Hayır |
public.note_body_span / NoteBodySpanProjection
Bölüm başlığı “public.note_body_span / NoteBodySpanProjection”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
position |
integer |
Evet | Hayır |
span_id |
uuid |
Evet | Hayır |
sentence_id |
uuid |
Evet | Hayır |
start_scalar |
integer |
Evet | Hayır |
end_scalar |
integer |
Evet | Hayır |
text |
string |
Evet | Hayır |
separator_after |
string |
Evet | Hayır |
public.note_marker / NoteMarkerProjection
Bölüm başlığı “public.note_marker / NoteMarkerProjection”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
position |
integer |
Evet | Hayır |
span_id |
uuid |
Evet | Hayır |
sentence_id |
uuid |
Evet | Hayır |
start_scalar |
integer |
Evet | Hayır |
end_scalar |
integer |
Evet | Hayır |
text |
string |
Evet | Hayır |
public.occurrence_context / OccurrenceContext
Bölüm başlığı “public.occurrence_context / OccurrenceContext”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
chapter_id |
uuid |
Evet | Hayır |
paragraph_id |
uuid |
Evet | Hayır |
sentence_id |
uuid |
Evet | Hayır |
start_position |
integer |
Evet | Hayır |
end_position |
integer |
Evet | Hayır |
excerpt |
string |
Evet | Hayır |
public.ottoman_reader_unit / OttomanReaderUnitProjection
Bölüm başlığı “public.ottoman_reader_unit / OttomanReaderUnitProjection”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
unit_id |
uuid |
Evet | Hayır |
sentence_id |
uuid |
Evet | Hayır |
first_occurrence_id |
uuid |
Evet | Hayır |
last_occurrence_id |
uuid |
Evet | Hayır |
start_position |
integer |
Evet | Hayır |
end_position |
integer |
Evet | Hayır |
latin_text |
string |
Evet | Hayır |
ottoman_text |
string |
Evet | Hayır |
trailing_text |
string |
Evet | Hayır |
reader_status |
ottoman_reader_status |
Evet | Hayır |
public.paragraph / ParagraphProjection
Bölüm başlığı “public.paragraph / ParagraphProjection”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
paragraph_id |
uuid |
Evet | Hayır |
chapter_id |
uuid |
Evet | Hayır |
position |
integer |
Evet | Hayır |
following_text |
string |
Evet | Hayır |
text_sha256 |
sha256 |
Evet | Hayır |
public.provenance_release_summary / ProvenanceReleaseSummary
Bölüm başlığı “public.provenance_release_summary / ProvenanceReleaseSummary”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
release_id |
uuid |
Evet | Hayır |
release_key |
string |
Evet | Hayır |
release_root |
sha256 |
Evet | Hayır |
public.provenance_source_summary / ProvenanceSourceSummary
Bölüm başlığı “public.provenance_source_summary / ProvenanceSourceSummary”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
source_key |
string |
Evet | Hayır |
release_key |
string |
Evet | Hayır |
attribution |
string? |
Hayır | Evet |
public.provenance_transformation_summary / ProvenanceTransformationSummary
Bölüm başlığı “public.provenance_transformation_summary / ProvenanceTransformationSummary”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
process_profile |
string |
Evet | Hayır |
result_root |
sha256 |
Evet | Hayır |
public.repetition_span / RepetitionSpanProjection
Bölüm başlığı “public.repetition_span / RepetitionSpanProjection”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
position |
integer |
Evet | Hayır |
span_id |
uuid |
Evet | Hayır |
sentence_id |
uuid |
Evet | Hayır |
start_scalar |
integer |
Evet | Hayır |
end_scalar |
integer |
Evet | Hayır |
text |
string |
Evet | Hayır |
public.sentence / SentenceProjection
Bölüm başlığı “public.sentence / SentenceProjection”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
sentence_id |
uuid |
Evet | Hayır |
paragraph_id |
uuid |
Evet | Hayır |
position |
integer |
Evet | Hayır |
initial_text |
string |
Evet | Hayır |
following_text |
string |
Evet | Hayır |
text_sha256 |
sha256 |
Evet | Hayır |
public.span_projection / SpanProjection
Bölüm başlığı “public.span_projection / SpanProjection”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
span_id |
uuid |
Evet | Hayır |
sentence_id |
uuid |
Evet | Hayır |
start_position |
integer |
Evet | Hayır |
end_position |
integer |
Evet | Hayır |
exact_text |
string |
Evet | Hayır |
public.supersession_path_step / SupersessionPathStep
Bölüm başlığı “public.supersession_path_step / SupersessionPathStep”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
position |
integer |
Evet | Hayır |
source_kind |
supersession_source_kind |
Evet | Hayır |
supersession_event_id |
uuid |
Evet | Hayır |
event_kind |
supersession_event_kind |
Evet | Hayır |
disposition |
supersession_disposition |
Evet | Hayır |
predecessor_ids |
uuid[] |
Evet | Hayır |
successor_ids |
uuid[] |
Evet | Hayır |
reason_code |
string |
Evet | Hayır |
public.token_occurrence / TokenOccurrenceProjection
Bölüm başlığı “public.token_occurrence / TokenOccurrenceProjection”Public projection tipi.
| Alan | Tip | Required | Nullable |
|---|---|---|---|
occurrence_id |
uuid |
Evet | Hayır |
sentence_id |
uuid |
Evet | Hayır |
position |
integer |
Evet | Hayır |
occurrence_kind |
token_occurrence_kind |
Evet | Hayır |
token_form_id |
uuid? |
Hayır | Evet |
body |
string |
Evet | Hayır |
trailing_text |
string |
Evet | Hayır |
Kapalı discriminator varyantları
Bölüm başlığı “Kapalı discriminator varyantları”Bu tablo validated compiler’ın aynı girdilerden ürettiği in-memory OpenAPI
projection’ından oluşturulur. Required alanlar ve varyanta özgü const,
null, pattern ve cardinality kısıtları korunur.
| Tip | Discriminator | Varyant | Required alanlar | Kısıtlar |
|---|---|---|---|---|
ApiError |
code |
invalid_request |
code, retryable, detail_code, retry_after_ms |
retryable=false, detail_code=non-null, detail_code.pattern=^validation:[a-z][a-z0-9_.-]{0,63}$, detail_code.maxLength=75, retry_after_ms=null |
ApiError |
code |
unauthenticated |
code, retryable, detail_code, retry_after_ms |
retryable=false, detail_code=null, retry_after_ms=null |
ApiError |
code |
not_found_or_forbidden |
code, retryable, detail_code, retry_after_ms |
retryable=false, detail_code=null, retry_after_ms=null |
ApiError |
code |
unsupported_contract |
code, retryable, detail_code, retry_after_ms |
retryable=false, detail_code=non-null, detail_code.pattern=^supported_majors:[1-9][0-9]*(?:,[1-9][0-9]*)*$, detail_code.maxLength=128, retry_after_ms=null |
ApiError |
code |
conflict |
code, retryable, detail_code, retry_after_ms |
retryable=false, detail_code=non-null, detail_code.pattern=^conflict:[a-z][a-z0-9_.-]{0,63}$, detail_code.maxLength=73, retry_after_ms=null |
ApiError |
code |
continuation_invalid |
code, retryable, detail_code, retry_after_ms |
retryable=false, detail_code=null, retry_after_ms=null |
ApiError |
code |
response_budget_exceeded |
code, retryable, detail_code, retry_after_ms |
retryable=false, detail_code=non-null, detail_code.pattern=^operation_limit:[a-z][a-z0-9_.-]{0,63}$, detail_code.maxLength=80, retry_after_ms=null |
ApiError |
code |
rate_limited |
code, retryable, detail_code, retry_after_ms |
retryable=true, detail_code=null, retry_after_ms=non-null, retry_after_ms.minimum=1 |
ApiError |
code |
integrity_failure |
code, retryable, detail_code, retry_after_ms |
retryable=false, detail_code=non-null, detail_code.pattern=^incident:[A-Za-z0-9_-]{8,119}$, detail_code.maxLength=128, retry_after_ms=null |
ApiError |
code |
service_unavailable |
code, retryable, detail_code, retry_after_ms |
retryable=true, detail_code=null, retry_after_ms=non-null, retry_after_ms.minimum=1 |
ApiError |
code |
timeout |
code, retryable, detail_code, retry_after_ms |
retryable=true, detail_code=null, retry_after_ms=non-null, retry_after_ms.minimum=1 |
ChapterAlignmentItem |
mapping_status |
mapped |
alignment_item_id, chapter_id, source_text_version_id, target_text_version_id, source_language_tag, target_language_tag, order_side, reader_position, order_status, alignment_group_id, accepted_order_position, authority_status, mapping_status, group_shape, source_units, target_units |
source_language_tag=tr, target_language_tag=en, alignment_group_id=non-null, accepted_order_position=non-null, authority_status=accepted, group_shape=non-null, source_units.minItems=1, target_units.minItems=1 |
ChapterAlignmentItem |
mapping_status |
unresolved_candidate |
alignment_item_id, chapter_id, source_text_version_id, target_text_version_id, source_language_tag, target_language_tag, order_side, reader_position, order_status, alignment_group_id, accepted_order_position, authority_status, mapping_status, group_shape, source_units, target_units |
source_language_tag=tr, target_language_tag=en, alignment_group_id=null, accepted_order_position=null, authority_status=unresolved, group_shape=null, source_units.minItems=1, target_units.minItems=1 |
ChapterAlignmentItem |
mapping_status |
source_fallback |
alignment_item_id, chapter_id, source_text_version_id, target_text_version_id, source_language_tag, target_language_tag, order_side, reader_position, order_status, alignment_group_id, accepted_order_position, authority_status, mapping_status, group_shape, source_units, target_units |
source_language_tag=tr, target_language_tag=en, alignment_group_id=null, accepted_order_position=null, authority_status=unresolved, group_shape=null, source_units.minItems=1, target_units.minItems=0, target_units.maxItems=0 |
ChapterAlignmentItem |
mapping_status |
target_only |
alignment_item_id, chapter_id, source_text_version_id, target_text_version_id, source_language_tag, target_language_tag, order_side, reader_position, order_status, alignment_group_id, accepted_order_position, authority_status, mapping_status, group_shape, source_units, target_units |
source_language_tag=tr, target_language_tag=en, alignment_group_id=null, accepted_order_position=null, authority_status=unresolved, group_shape=null, source_units.minItems=0, source_units.maxItems=0, target_units.minItems=1 |
TokenOccurrenceProjection |
occurrence_kind |
form |
occurrence_id, sentence_id, position, body, trailing_text, occurrence_kind, token_form_id |
token_form_id=non-null |
TokenOccurrenceProjection |
occurrence_kind |
literal |
occurrence_id, sentence_id, position, body, trailing_text, occurrence_kind |
token_form_id=null |
Failure envelope varyantları
Bölüm başlığı “Failure envelope varyantları”Bu tablo dispatch öncesi ve sonrası failure ayrımını compiler’ın in-memory OpenAPI projection’ından exact alan setiyle gösterir.
| Error code | Component | operation_id | release_context | Required alanlar |
|---|---|---|---|---|
conflict |
ConflictFailure |
path-specific logical operation const (20 operations) |
non-null |
request_id, operation_id, error, release_context |
continuation_invalid |
ContinuationInvalidFailure |
path-specific logical operation const (20 operations) |
non-null |
request_id, operation_id, error, release_context |
integrity_failure |
IntegrityFailureFailure |
path-specific logical operation const (20 operations) |
non-null |
request_id, operation_id, error, release_context |
invalid_request |
InvalidRequestFailure |
path-specific logical operation const (20 operations) |
non-null |
request_id, operation_id, error, release_context |
not_found_or_forbidden |
NotFoundOrForbiddenFailure |
path-specific logical operation const (20 operations) |
non-null |
request_id, operation_id, error, release_context |
rate_limited |
RateLimitedFailure |
path-specific logical operation const (20 operations) |
non-null |
request_id, operation_id, error, release_context |
response_budget_exceeded |
ResponseBudgetExceededFailure |
path-specific logical operation const (20 operations) |
non-null |
request_id, operation_id, error, release_context |
service_unavailable |
ServiceUnavailableFailure |
path-specific logical operation const (20 operations) |
non-null |
request_id, operation_id, error, release_context |
timeout |
TimeoutFailure |
path-specific logical operation const (20 operations) |
non-null |
request_id, operation_id, error, release_context |
unauthenticated |
UnauthenticatedFailure |
path-specific logical operation const (20 operations) |
non-null |
request_id, operation_id, error, release_context |
unsupported_contract |
UnsupportedContractFailure |
null before dispatch |
null |
request_id, operation_id, error, release_context |