Documentació d'Asset Core

Documentació del motor d'estat del món determinista i referències de l'API.

Decision Gate docs

escriure Punts Finals

Escriviu operacions de daemon (transaccions i mutacions)

Punts d’extremitat

GET /v1/write/health

Resum: OpenAPI metadades per a la salut del daemon d’escriptura.

Operation ID: health_endpoint

Respostes

EstatDescripcióEsquema
200Estat de salut del daemon d’escripturaHealthResponse
503Les comprovacions de salut han fallatProblemDetails

GET /v1/write/livez

Resum: OpenAPI metadades per a la prova de viabilitat del daemon d’escriptura.

Operation ID: livez_endpoint

Respostes

EstatDescripcióEsquema
200Prova de viabilitat del daemon d’escripturaProbeResponse
503El daemon d’escriptura no està actiuProblemDetails

GET /v1/write/namespaces

Resum: OpenAPI metadades per a llistat d’espais de noms.

Operation ID: list_namespaces_endpoint

Paràmetres

NomEnRequeritTipusDescripció
limitconsultanoenterNombre màxim d’articles a retornar.
page_tokenconsultanoPageTokenToken de paginació opac per a la següent pàgina.
tenant_idconsultanoTenantIdFiltre de llogater opcional.
owner_principal_idconsultanoPrincipalIdFiltre de principal propietari opcional.
policy_classconsultanoPolicyClassFiltre de classe de política opcional.
lifecycleconsultanoLifecycleStateFiltre de cicle de vida opcional.
write_modeconsultanoNamespaceWriteModeFiltre de mode d’escriptura opcional.
drainingconsultanobooleanFiltre de drenatge opcional.
frozenconsultanobooleanFiltre de congelat opcional.
include_deletedconsultanobooleanIncloure espais de noms eliminats quan sigui cert.

Respostes

EstatDescripcióEsquema
200Llista d’espais de nomsNamespaceListResponse
401Sol·licitud no autoritzadaProblemDetails
404Espai de noms no trobatProblemDetails
429Quota excedidaProblemDetails
500Error intern del daemonProblemDetails

POST /v1/write/namespaces

Resum: OpenAPI metadades per a la creació d’espais de noms.

Operation ID: create_namespace_endpoint

Correu de sol·licitud

  • Content type: application/json
  • Esquema: NamespaceCreateRequest

Respostes

EstatDescripcióEsquema
200Namespace creat o ja presentNamespaceCreateResponse
400Identificador de namespace no vàlidProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Namespace no trobatProblemDetails
429Quota excedidaProblemDetails
500Error intern del daemonProblemDetails

ELIMINAR /v1/escriure/nomsespais/{namespace_id}

Resum: OpenAPI metadades per eliminar espais de noms.

Operation ID: delete_namespace_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms

Respostes

EstatDescripcióEsquema
200Namespace eliminatNamespaceDeleteResponse
400Identificador de namespace no vàlidProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Namespace no trobatProblemDetails
412Namespace té recursos adjuntsProblemDetails
429Quota excedidaProblemDetails
500Error intern del daemonProblemDetails

GET /v1/write/namespaces/{namespace_id}

Resum: OpenAPI metadades per obtenir metadades de l’espai de noms.

Operation ID: get_namespace_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms

Respostes

EstatDescripcióEsquema
200Metadades del namespaceNamespaceGetResponse
400Identificador de namespace no vàlidProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Namespace no trobatProblemDetails
429Quota excedidaProblemDetails
500Error intern del daemonProblemDetails

PATCH /v1/write/namespaces/{namespace_id}

Resum: OpenAPI metadades per actualitzar les metadades de l’espai de noms.

Operation ID: update_namespace_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms

Correu de sol·licitud

  • Content type: application/json
  • Esquema: NamespaceUpdateRequest

Respostes

EstatDescripcióEsquema
200Espai de noms actualitzatNamespaceUpdateResponse
400Identificador d’espai de noms no vàlidProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Espai de noms no trobatProblemDetails
412Condició prèvia de revisió fallidaProblemDetails
429Quota excedidaProblemDetails
500Error intern del daemonProblemDetails

POST /v1/write/namespaces/{namespace_id}/commit

Resum: OpenAPI metadades per a la presentació de compromisos.

Operation ID: commit_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms

Correu de sol·licitud

  • Content type: application/json
  • Schema: CommitRequest

Respostes

EstatDescripcióEsquema
200Compromís acceptatCommitResponse
400Payload de compromís no vàlidProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Espai de noms no trobatProblemDetails
409Clau d’idempotència reutilitzada amb un payload diferentProblemDetails
422Validació del compromís fallidaProblemDetails
429Quota excedidaProblemDetails
500Error intern del daemonProblemDetails

POST /v1/write/namespaces/{namespace_id}/commit/preflight

Resum: OpenAPI metadades per al preflight de commit.

Operation ID: commit_preflight_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms

Correu de sol·licitud

  • Content type: application/json
  • Schema: CommitRequest

Respostes

EstatDescripcióEsquema
200Resultat del preflight de commitPreflightCommitResponse
400Càrrega de commit no vàlidaProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Espai de noms no trobatProblemDetails
422Validació del commit fallidaProblemDetails
429Quota excedidaProblemDetails
500Error intern del daemonProblemDetails

POST /v1/write/namespaces/{namespaceid}/commits/{commitid}/reverse

Resum: OpenAPI metadades per a revertir compromisos.

Operation ID: reverse_commit_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idpathNamespaceIdIdentificador de l’espai de noms
commit_idpathstringIdentificador del commit

Correu de sol·licitud

  • Content type: application/json
  • Esquema: ReverseCommitRequest

Respostes

EstatDescripcióEsquema
200Compromís invers aplicatReverseCommitResponse
400Càrrega de compromís invers no vàlidaProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Compromís no trobatProblemDetails
409Fallida de la precondició del compromís inversProblemDetails
410Compromís invers ja no disponibleProblemDetails
422Fallida de la validació del compromís inversProblemDetails
429Quota excedidaProblemDetails
500Error intern del daemonProblemDetails

POST /v1/write/namespaces/{namespace_id}/lifecycle

Resum: OpenAPI metadades per actualitzar el cicle de vida de l’espai de noms.

Operation ID: namespace_lifecycle_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms

Correu de sol·licitud

  • Content type: application/json
  • Esquema: NamespaceLifecycleRequest

Respostes

EstatDescripcióEsquema
200Cicle de vida de l’espai de noms actualitzatNamespaceLifecycleResponse
400Identificador d’espai de noms no vàlidProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Espai de noms no trobatProblemDetails
412Condició prèvia de revisió fallidaProblemDetails
429Quota excedidaProblemDetails
500Error intern del daemonProblemDetails

POST /v1/write/namespaces/{namespaceid}/operationalstate

Resum: OpenAPI metadades per actualitzar l’estat operatiu de l’espai de noms.

Operation ID: namespace_operational_state_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms

Correu de sol·licitud

  • Content type: application/json
  • Esquema: NamespaceOperationalStateRequest

Respostes

EstatDescripcióEsquema
200Estat operatiu de l’espai de noms actualitzatNamespaceOperationalStateResponse
400Identificador d’espai de noms no vàlidProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Espai de noms no trobatProblemDetails
412Fallida de la condició prèvia de revisióProblemDetails
429Quota excedidaProblemDetails
500Error intern del daemonProblemDetails

POST /v1/write/namespaces/{namespace_id}/placement

Resum: OpenAPI metadades per actualitzar la col·locació de l’espai de noms.

Operation ID: namespace_placement_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms

Correu de sol·licitud

  • Content type: application/json
  • Esquema: NamespacePlacementRequest

Respostes

EstatDescripcióEsquema
200Col·locació de l’espai de noms actualitzadaNamespacePlacementResponse
400Identificador d’espai de noms no vàlidProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Espai de noms no trobatProblemDetails
412Condició prèvia de revisió fallidaProblemDetails
429Quota excedidaProblemDetails
500Error intern del daemonProblemDetails

POST /v1/write/namespaces/{namespaceid}/registerclass

Resum: OpenAPI metadades per a la registració de classes.

Operation ID: register_class_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms

Correu de sol·licitud

  • Content type: application/json
  • Esquema: RegisterClassRequest

Respostes

EstatDescripcióEsquema
200Classe registradaRegisterClassResponse
400Càrrega de sol·licitud no vàlidaProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Espai de noms no trobatProblemDetails
409La classe ja existeixProblemDetails
429Quota excedidaProblemDetails
500Error intern del daemonProblemDetails

POST /v1/write/namespaces/{namespaceid}/registerclasscontinuousshape_1d

Resum: OpenAPI metadades per al registre continu de formes de classe 1D.

Operation ID: register_class_continuous_shape_1d_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms

Correu de sol·licitud

  • Content type: application/json
  • Esquema: RegisterClassContinuousShape1dRequest

Respostes

EstatDescripcióEsquema
200Forma de classe 1D contínua registradaRegisterClassContinuousShape1dResponse
400Càrrega de sol·licitud no vàlidaProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Espai de noms no trobatProblemDetails
409La forma de classe ja existeixProblemDetails
429Quota excedidaProblemDetails
500Error intern del daemonProblemDetails

POST /v1/write/namespaces/{namespaceid}/registerclasscontinuousshape_2d

Resum: OpenAPI metadades per al registre de formes de classe contínues 2D.

Operation ID: register_class_continuous_shape_2d_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms

Correu de sol·licitud

  • Content type: application/json
  • Esquema: RegisterClassContinuousShape2dRequest

Respostes

EstatDescripcióEsquema
200Forma de classe 2D contínua registradaRegisterClassContinuousShape2dResponse
400Càrrega de sol·licitud no vàlidaProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Espai de noms no trobatProblemDetails
409La forma de classe ja existeixProblemDetails
429Quota excedidaProblemDetails
500Error intern del daemonProblemDetails

POST /v1/write/namespaces/{namespaceid}/registerclass_shape

Resum: OpenAPI metadades per al registre de formes de classe.

Operation ID: register_class_shape_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms

Correu de sol·licitud

  • Content type: application/json
  • Esquema: RegisterClassShapeRequest

Respostes

EstatDescripcióEsquema
200Forma de classe registradaRegisterClassShapeResponse
400Càrrega de sol·licitud no vàlidaProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Espai de noms no trobatProblemDetails
409La forma de classe ja existeixProblemDetails
429Quota excedidaProblemDetails
500Error intern del daemonProblemDetails

GET /v1/write/namespaces/{namespace_id}/status

Resum: OpenAPI metadades per a l’estat de l’espai de noms.

Operation ID: namespace_status_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms

Respostes

EstatDescripcióEsquema
200Metadades d’estat de l’espai de nomsNamespaceStatusResponse
400Identificador d’espai de noms no vàlidProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Espai de noms no trobatProblemDetails
429Quota excedidaProblemDetails
500Error intern del daemonProblemDetails

GET /v1/write/namespaces/changes

Resum: OpenAPI metadades per a llistat de canvis d’espai de noms.

Operation ID: list_namespace_changes_endpoint

Paràmetres

NomEnRequeritTipusDescripció
limitconsultanoenterNombre màxim d’articles a retornar.
page_tokenconsultanoChangeTokenToken opac de paginació per a la següent pàgina.
since_updated_at_msconsultaenterLímite inferior per a les marques de temps actualitzades (mil·lisegons des de l’epoch).
tenant_idconsultanoTenantIdFiltre opcional de llogater.
owner_principal_idconsultanoPrincipalIdFiltre opcional de principal propietari.
policy_classconsultanoPolicyClassFiltre opcional de classe de política.
lifecycleconsultanoLifecycleStateFiltre opcional de cicle de vida.
write_modeconsultanoNamespaceWriteModeFiltre opcional de mode d’escriptura.
drainingconsultanobooleanFiltre opcional de drenatge.
frozenconsultanobooleanFiltre opcional de congelat.

Respostes

EstatDescripcióEsquema
200Llista de canvis de namespaceNamespaceChangeListResponse
400Paràmetres de sol·licitud no vàlidsProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Namespace no trobatProblemDetails
429Quota excedidaProblemDetails
500Error intern del daemonProblemDetails

POST /v1/write/namespaces/forkfromsnapshot

Resum: OpenAPI metadades per bifurcar espais de noms.

ID d’operació: fork_namespace_from_snapshot_endpoint

Correu de sol·licitud

  • Content type: application/json
  • Esquema: NamespaceForkFromSnapshotRequest

Respostes

EstatDescripcióEsquema
200Namespace bifurcat del snapshotNamespaceForkFromSnapshotResponse
400Paràmetres de sol·licitud no vàlidsProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Namespace no trobatProblemDetails
409Namespace ja existeixProblemDetails
422Validació del snapshot fallidaProblemDetails
429Quota excedidaProblemDetails
500Error intern del daemonProblemDetails

GET /v1/write/namespaces/status

Resum: OpenAPI metadades per a llistat dels registres d’estat de l’espai de noms.

Operation ID: namespace_status_list_endpoint

Respostes

EstatDescripcióEsquema
200Llista d’estats de l’espai de nomsNamespaceStatusListResponse
401Sol·licitud no autoritzadaProblemDetails
404Espai de noms no trobatProblemDetails
429Quota excedidaProblemDetails
500Error intern del daemonProblemDetails

GET /v1/write/readyz

Resum: OpenAPI metadades per a la sonda de disponibilitat del daemon d’escriptura.

Operation ID: readyz_endpoint

Respostes

EstatDescripcióEsquema
200Prova de disponibilitat del daemon d’escripturaReadyzResponse
503El daemon d’escriptura no està llestReadyzResponse

GET /v1/write/startupz

Resum: OpenAPI metadades per a la prova d’inici del daemon de escritura.

Operation ID: startupz_endpoint

Respostes

EstatDescripcióEsquema
200Prova d’inici del daemon d’escripturaProbeResponse
503El daemon d’escriptura no ha començatProblemDetails