5.13 Traceability Matrix
Every requirement of the data model should be served by at least one operation, event or call, and every operation should serve a requirement. This page is generated from the contracts by uv run docs-interfaces: each operation carries the requirements it serves in x-moonitoring-requirements, each event in its AsyncAPI operation, each gRPC service in its file header; the requirement numbers are those of 1.requisiti-raffinati.txt, as the Data pages show them.
The contracts hold 508 REST operations in 32 domains, 71 events and 19 gRPC calls, checked against 185 top-level requirements: 0 requirements have no operation, 13 operations have no requirement, 0 catalog capabilities are checked by no operation and 1 capabilities checked by a contract are not in the catalog, 1 of them proposed.
5.13.1 Gaps¶
A gap is not an error of the contracts but a question: a requirement marked future work waits for a case, an operation without a requirement serves a system the data model does not describe yet, a capability nobody checks may be redundant. Each is listed under Open Decisions.
Requirements without an operation, event or RPC:
- none
Operations without a requirement (the data model has no requirement for them yet; see the open decisions):
status/feed:getSummarystatus/incidents:listComponents,updateComponent,listIncidents,openIncident,getIncident,updateIncident,postIncidentUpdate,listMaintenances,scheduleMaintenance,updateMaintenance,listProbes,updateProbe
Capabilities of the catalog that no operation checks:
- none
Capabilities the contracts check and the catalog does not have (proposed when their operations say so; any other one is a mistake in a contract or in the catalog):
access.organization_audit.read: proposed, checked bylistOrganizationAuditEvents
5.13.2 Matrix¶
One row per top-level requirement (an entity or a type), with the REST operations as domain.operationId, the events and the gRPC calls that serve it or one of its fields and subtypes.
Farm: Users, Organizations And Access Control¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 1 | User | 12: organizations.getCurrentUser, organizations.updateCurrentUser, organizations.listServiceAccounts, organizations.createServiceAccount, organizations.disableServiceAccount, organizations.rotateServiceAccountCredential and 6 more |
2: user.disabled.v1, service_account.registered.v1 |
3: OrganizationsService.StreamSnapshot, OrganizationsService.RegisterServiceAccount, OrganizationsService.DisableServiceAccount |
| 2 | Organization | 24: organizations.listOrganizations, organizations.createOrganization, organizations.countOrganizations, organizations.getOrganization, organizations.updateOrganization, organizations.getOrganizationClosure and 18 more |
3: organization.created.v1, organization.closing.v1, organization.updated.v1 |
— |
| 3 | Nation | 3: organizations.listNations, organizations.createNation, organizations.updateNation |
— | — |
| 5 | OrganizationAccessControlMembership | 10: organizations.getCurrentUser, organizations.createOrganization, organizations.listMembers, organizations.acceptInvitation, organizations.joinThroughLink, organizations.revokeMembership and 4 more |
2: membership.granted.v1, membership.revoked.v1 |
3: OrganizationsService.StreamSnapshot, OrganizationsService.RegisterServiceAccount, OrganizationsService.DisableServiceAccount |
| 6 | OrganizationRoleAccessControl | 12: organizations.inviteMember, organizations.createJoinLink, organizations.approveJoinRequest, organizations.changeMemberRole, organizations.createDelegation, organizations.changeDelegationRole and 6 more |
1: organization_role.updated.v1 |
3: OrganizationsService.StreamSnapshot, OrganizationsService.RegisterServiceAccount, OrganizationsService.DisableServiceAccount |
| 8 | OrganizationDelegationMembership | 10: organizations.listDelegations, organizations.createDelegation, organizations.revokeDelegation, organizations.changeDelegationRole, organizations.listShareCodes, organizations.createShareCode and 4 more |
2: delegation.granted.v1, delegation.revoked.v1 |
3: OrganizationsService.StreamSnapshot, OrganizationsService.RegisterServiceAccount, OrganizationsService.DisableServiceAccount |
| 9 | CooperativeConstraint | 5: organizations.listCooperativeMemberFarms, organizations.listCooperativeConstraints, organizations.createCooperativeConstraint, organizations.updateCooperativeConstraint, organizations.deleteCooperativeConstraint |
— | — |
| 68 | Entitlement | 16: staff.listCapabilityCatalogs, webhooks.listWebhookEventTypes, models.listRegisteredModels, models.registerModel, entitlements.listFeatures, entitlements.listOrganizationEntitlements and 10 more |
4: entitlement.granted.v1, entitlement.changed.v1, entitlement.revoked.v1, feature_usage.limit_reached.v1 |
5: CatalogService.GetCatalog, EntitlementsService.Check, EntitlementsService.StreamSnapshot, UsageService.Reserve, UsageService.Settle |
| 69 | FeatureUsage | 5: completions.listModelCalls, completions.getModelCall, entitlements.listOrganizationUsage, entitlements.listStaffUsage, conversations.sendMessage |
2: model_call.completed.v1, feature_usage.limit_reached.v1 |
8: CompletionsService.Complete, CompletionsService.Embed, BatchesService.SubmitBatch, BatchesService.GetBatch, EntitlementsService.Check, EntitlementsService.StreamSnapshot and 2 more |
| 70 | PlatformAuditEvent (immutable) | 14: audit.listAuditEvents, audit.getAuditEvent, audit.listOrganizationAuditEvents, organizations.setOrganizationStatus, calls.holdCall, calls.restoreCallRevision and 8 more |
1: platform_audit_event.recorded.v1 |
— |
| 132 | UserGroup | 5: organizations.listUserGroups, organizations.createUserGroup, organizations.getUserGroup, organizations.updateUserGroup, organizations.archiveUserGroup |
— | — |
| 133 | UserGroupMembership | 5: organizations.acceptInvitation, organizations.joinThroughLink, organizations.listUserGroupMembers, organizations.addUserGroupMember, organizations.revokeUserGroupMembership |
1: membership.granted.v1 |
— |
| 134 | UserGroupRoleAssignment | 3: organizations.listUserGroupRoles, organizations.assignUserGroupRole, organizations.revokeUserGroupRole |
1: membership.granted.v1 |
— |
| 138 | OrganizationClosure | 4: organizations.getOrganizationClosure, organizations.requestOrganizationClosure, organizations.cancelOrganizationClosure, organizations.holdOrganizationClosure |
3: organization.closing.v1, organization.closure_cancelled.v1, organization.closed.v1 |
— |
| 139 | OrganizationInvitation | 6: organizations.listInvitations, organizations.inviteMember, organizations.resendInvitation, organizations.revokeInvitation, organizations.previewInvitation, organizations.acceptInvitation |
— | — |
| 140 | RefreshToken | 3: tokens.issueToken, tokens.revokeToken, tokens.registerPerson |
— | — |
| 141 | CapabilityCatalog | 1: webhooks.listWebhookEventTypes |
— | 1: CatalogService.GetCatalog |
| 142 | OrganizationJoinLink | 5: organizations.listJoinLinks, organizations.createJoinLink, organizations.revokeJoinLink, organizations.previewJoinLink, organizations.joinThroughLink |
— | — |
| 143 | OrganizationJoinRequest | 4: organizations.listJoinRequests, organizations.approveJoinRequest, organizations.rejectJoinRequest, organizations.joinThroughLink |
— | — |
| 144 | WebhookSubscription | 7: webhooks.listWebhookSubscriptions, webhooks.createWebhookSubscription, webhooks.getWebhookSubscription, webhooks.updateWebhookSubscription, webhooks.deleteWebhookSubscription, webhooks.testWebhookSubscription and 1 more |
— | 1: CatalogService.GetCatalog |
| 145 | FailedDelivery | 2: webhooks.listFailedDeliveries, webhooks.redeliverFailedDelivery |
— | — |
Farm: Moonitoring Users And Access Control¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 24 | MoonitoringAccessControlMembership | 5: staff.getCurrentStaffUser, staff.listStaffMemberships, staff.createStaffMembership, staff.revokeStaffMembership, tokens.getJwks |
1: staff_membership.changed.v1 |
— |
| 25 | MoonitoringRoleAccessControl | 5: staff.getCurrentStaffUser, staff.createStaffMembership, staff.listStaffRoles, staff.createStaffRole, staff.updateStaffRole |
1: staff_role.updated.v1 |
— |
| 26 | MoonitoringUser | 11: staff.getCurrentStaffUser, staff.listStaffUsers, staff.createStaffUser, staff.getStaffUser, staff.disableStaffUser, staff.linkStaffGoogleServiceAccount and 5 more |
— | — |
Farm: Animals¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 10 | Animal | 6: animals.listAnimals, animals.registerAnimal, animals.getAnimal, animals.listAnimalProfileEvidence, animals.listAnimalBreeds, animals.listAnimalHistory |
1: animal.registered.v1 |
— |
| 11 | AnimalType | 2: animals.listAnimalTypes, animals.createAnimalType |
— | — |
| 14 | AnimalBreedType | 2: animals.listBreedTypes, animals.createBreedType |
— | — |
| 22 | BreedMembership | 1: animals.listAnimalBreeds |
— | — |
| 65 | AnimalProfileEvidence | 3: animals.registerAnimal, animals.listAnimalProfileEvidence, animals.addAnimalProfileEvidence |
— | — |
Farm: Animal Groups¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 12 | AnimalGroup | 5: animals.listAnimalGroups, animals.createAnimalGroup, animals.getAnimalGroup, animals.updateAnimalGroup, animals.archiveAnimalGroup |
— | — |
| 13 | AnimalGroupMembership | 3: animals.listGroupMembers, animals.addGroupMember, animals.closeGroupMembership |
— | — |
Farm: Identifiers¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 15 | ExternalIdentifier | 5: animals.listAnimals, animals.registerAnimal, animals.listAnimalIdentifiers, animals.addAnimalIdentifier, animals.invalidateIdentifier |
1: animal.registered.v1 |
— |
Farm: Ownership¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 16 | Ownership | 5: animals.listAnimals, animals.registerAnimal, animals.listAnimalOwnerships, animals.transferAnimal, animals.transferAnimalGroup |
1: ownership.transferred.v1 |
— |
Farm: Provenance¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 17 | SourceProducerEntity | 4: events.getEventLineage, observations.getObservationLineage, sources.getProducer, sync.openSyncRun |
— | — |
| 18 | SourceVersion | 5: sources.listChannelVersions, sources.createChannelVersion, sources.listOriginVersions, sources.createOriginVersion, sources.getProducer |
— | — |
| 19 | SourceOrigin | 8: events.recordEvent, observations.recordObservation, observations.requestPredictions, sources.listOrigins, sources.createOrigin, sources.createOrganizationOrigin and 2 more |
— | 1: ComputedRecordsService.AppendComputedRecords |
| 32 | SourceChannel | 10: animals.registerAnimal, animals.addAnimalProfileEvidence, events.recordEvent, files.createUpload, observations.recordObservation, sources.setFeedCredential and 4 more |
— | — |
| 33 | Device | 4: sources.listDevices, sources.createDevice, sources.getDevice, sources.updateDevice |
— | — |
| 34 | DeviceAssignment | 3: sources.listDeviceAssignments, sources.createDeviceAssignment, sources.closeDeviceAssignment |
— | — |
| 44 | SourceFeed | 10: sources.listOrganizationFeeds, sources.createFeed, sources.listFeeds, sources.getFeed, sources.updateFeed, sources.disconnectFeed and 4 more |
2: source_feed.connected.v1, source_feed.disconnected.v1 |
— |
| 135 | SourceAdapter | 4: sources.listSourceAdapters, sources.createSourceAdapter, sources.setSourceAdapterStatus, sync.openSyncRun |
— | — |
| 136 | IntegrationGap | 3: sources.listIntegrationGaps, sources.getIntegrationGap, sources.updateIntegrationGap |
— | — |
| 137 | IntegrationGapOccurrence | 3: sources.listIntegrationGapOccurrences, sources.getIntegrationGapSampleUrl, sync.openSyncRun |
— | — |
| 146 | AdapterMapping | 5: sources.listAdapterMappings, sources.createAdapterMapping, sources.retireAdapterMapping, sources.resolveAdapterMapping, sync.getMySyncClient |
— | — |
Farm: Canonical Data, Events And Periods¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 27 | CanonicalObservation | 8: observations.listObservations, observations.recordObservation, observations.getObservation, observations.listObservationRevisions, observations.getObservationLineage, observations.correctObservation and 2 more |
— | — |
| 28 | CanonicalEvent | 7: events.listEvents, events.recordEvent, events.getEvent, events.listEventRevisions, events.getEventLineage, events.correctEvent and 1 more |
— | — |
| 29 | DeathType | 2: events.listDeathTypes, events.createDeathType |
— | — |
| 30 | RawMetadata | 11: events.getEventLineage, files.listOrganizationRawFiles, files.getRawFile, files.getRawFileDownloadUrl, files.removeRawFile, files.createUpload and 5 more |
3: sync_run.committed.v1, raw_file.committed.v1, raw_file.removed.v1 |
— |
| 31 | CanonicalPeriod | 2: events.listPeriods, events.getPeriod |
— | — |
| 35 | ObservationType | 5: observations.listObservationTypes, observations.createObservationType, observations.getObservationType, observations.activateObservationType, observations.retireObservationType |
— | — |
| 36 | ObservationMethod | 2: observations.listObservationMethods, observations.createObservationMethod |
— | — |
| 37 | BodySite | 2: observations.listBodySites, observations.createBodySite |
— | — |
| 38 | ObservationSession | 3: observations.listSessions, observations.getSession, observations.listSessionObservations |
— | — |
| 39 | Offspring | 1: events.listEventOffspring |
— | — |
| 40 | TreatmentProduct | 1: events.listEventProducts |
— | — |
| 41 | IngestionSkip | 3: files.listRawFileSkips, files.listOrganizationSkips, files.getSkipDetailUrl |
— | — |
| 42 | PeriodType | 2: events.listPeriodTypes, events.createPeriodType |
— | — |
| 43 | FarmConfiguration | 3: events.listFarmConfigurations, events.createFarmConfiguration, submissions.createSubmission |
— | — |
| 64 | ObservationContext | 2: observations.listObservationContexts, observations.createObservationContext |
— | — |
Farm: Reconciliation And Identity Resolution¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 45 | ResolvedEvent | 4: reconciliation.listResolvedEvents, reconciliation.getResolvedEvent, reconciliation.listResolvedEventRevisions, reconciliation.createResolutionRun |
1: resolved_event.published.v1 |
— |
| 46 | EventEvidence | 1: reconciliation.getResolvedEvent |
— | — |
| 47 | AnimalLink | 3: reconciliation.listAnimalLinks, reconciliation.getAnimalLink, reconciliation.createResolutionRun |
1: animal.merged.v1 |
— |
| 48 | DataIssue | 4: webhooks.listWebhookEventTypes, reconciliation.listDataIssues, reconciliation.listAllDataIssues, reconciliation.getDataIssue |
2: data_issue.opened.v1, data_issue.closed.v1 |
— |
| 49 | ReconciliationRuleSet | 4: reconciliation.listRuleSets, reconciliation.createRuleSet, reconciliation.getRuleSet, reconciliation.createResolutionRun |
— | — |
| 50 | SourceReliability | 2: reconciliation.listSourceReliability, reconciliation.createSourceReliability |
— | — |
| 51 | ParseJob | 7: files.listRawFileParseJobs, files.commitUpload, files.listParseJobs, files.createParseJobs, files.getParseJob, files.retryParseJob and 1 more |
4: sync_run.committed.v1, parse_job.requested.v1, parse_job.finished.v1, parse_job.dead.v1 |
— |
| 52 | SyncRun | 13: webhooks.listWebhookEventTypes, files.commitUpload, sync.openSyncRun, sync.commitSyncRun, sync.failSyncRun, sync.heartbeatSyncRun and 7 more |
2: sync_run.committed.v1, sync_run.failed.v1 |
— |
| 66 | FeedCoverage | 1: sources.listFeedCoverage |
1: feed_coverage.updated.v1 |
— |
Farm: Samples, Product Material And Derivation¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 54 | Sample | 2: observations.listSamples, observations.getSample |
— | — |
| 55 | ProductMaterial | 2: observations.listProductMaterials, observations.getProductMaterial |
— | — |
| 56 | ObservationSelection | 1: observations.getObservationSelection |
— | — |
| 57 | CanonicalDerivation | 2: observations.getDerivation, observations.requestPredictions |
— | 1: ComputedRecordsService.AppendComputedRecords |
Farm: Synchronisation Settings And Official Submissions¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 58 | SyncSchedule | 5: sync.getMySyncClient, sync.listSchedules, sync.createSchedule, sync.updateSchedule, sync.deleteSchedule |
— | — |
| 59 | SyncDigest | 3: sync.reportDigests, sync.listDigests, sync.listKnownKeys |
— | — |
| 60 | OfficialSubmission | 7: submissions.listSubmissionFormats, submissions.listSubmissions, submissions.createSubmission, submissions.getSubmission, submissions.getSubmissionPayloadUrl, submissions.sendSubmission and 1 more |
2: official_submission.sent.v1, official_submission.outdated.v1 |
— |
| 67 | SyncClient | 11: tokens.issueToken, sync.redeemEnrolment, sync.getMySyncClient, sync.reportMyInstallation, sync.getSyncStats, sync.listOrganizationSyncClients and 5 more |
3: service_account.registered.v1, sync_client.enrolled.v1, sync_client.retired.v1 |
4: OrganizationsService.StreamSnapshot, OrganizationsService.RegisterServiceAccount, OrganizationsService.DisableServiceAccount, InstallationsService.VerifyInstallation |
Farm: Versioning And Reproducibility¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 61 | WriteCommit | 12: datasets.buildDatasetVersion, events.getEventLineage, events.correctEvent, events.cancelEvent, files.removeRawFile, observations.getObservationLineage and 6 more |
1: write_commit.committed.v1 |
4: ComputedRecordsService.AppendComputedRecords, WatermarkService.GetWatermark, ExportsService.StartExport, ExportsService.GetExport |
| 62 | ModelRun | 8: models.listModelVersions, models.registerModelVersion, models.listScoringBatches, models.createScoringBatch, runs.listModelRuns, runs.createModelRun and 2 more |
1: scoring_batch.completed.v1 |
3: ModelsService.ListModels, ModelsService.Predict, ComputedRecordsService.AppendComputedRecords |
| 63 | ErasureRequest | 4: versioning.listErasureRequests, versioning.createErasureRequest, versioning.listAllErasureRequests, versioning.executeErasureRequest |
2: erasure_request.created.v1, erasure_request.executed.v1 |
— |
| 71 | MlDataset | 5: datasets.listDatasets, datasets.createDataset, datasets.getDataset, datasets.updateDataset, datasets.archiveDataset |
— | 3: WatermarkService.GetWatermark, ExportsService.StartExport, ExportsService.GetExport |
| 72 | MlDatasetVersion (immutable) | 6: datasets.listDatasetVersions, datasets.buildDatasetVersion, datasets.getDatasetVersion, datasets.deleteDatasetVersion, datasets.buildDatasetVariant, datasets.getDatasetManifest |
3: dataset_version.ready.v1, dataset_version.failed.v1, dataset_export.completed.v1 |
3: WatermarkService.GetWatermark, ExportsService.StartExport, ExportsService.GetExport |
| 73 | MlDatasetFile (immutable) | 2: datasets.deleteDatasetVersion, datasets.listDatasetFiles |
1: dataset_export.completed.v1 |
3: WatermarkService.GetWatermark, ExportsService.StartExport, ExportsService.GetExport |
| 74 | Model | 5: models.listRegisteredModels, models.registerModel, models.getRegisteredModel, models.retireModel, models.deployModelVersion |
— | — |
| 75 | ModelVersion | 4: models.listModelVersions, models.registerModelVersion, models.deployModelVersion, models.retireModelVersion |
— | — |
| 76 | ScoringBatch | 3: models.listScoringBatches, models.createScoringBatch, models.getScoringBatch |
— | — |
Farm: Client Releases And Distribution¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 100 | ReleaseProject | 3: builds.listReleaseProjects, builds.createReleaseProject, builds.updateReleaseProject |
— | — |
| 101 | ReleaseApplication | 7: builds.listReleaseApplications, builds.createReleaseApplication, builds.updateReleaseApplication, builds.listReleaseInstallerArtifacts, channels.getDownloadPage, downloads.getLatestDownload and 1 more |
— | — |
| 102 | ReleasePlatform | 2: builds.listReleasePlatforms, builds.createReleasePlatform |
— | — |
| 103 | ReleaseDepot | 3: builds.listReleaseDepots, builds.createReleaseDepot, builds.updateReleaseDepot |
— | — |
| 104 | ReleaseApplicationDepot | 3: builds.listApplicationDepots, builds.setApplicationDepot, builds.deleteApplicationDepot |
— | — |
| 105 | ReleaseChunk (immutable) | 2: builds.checkReleaseChunks, builds.purgeReleaseStorage |
— | — |
| 106 | ReleaseManifest (immutable) | 3: builds.createReleaseManifest, builds.getReleaseManifest, installations.checkForUpdate |
— | — |
| 107 | ReleaseManifestFile (optional) | 1: builds.listReleaseManifestFiles |
— | — |
| 108 | ReleasePatchArtifact (optional) | 3: builds.listReleasePatches, builds.createReleasePatch, installations.checkForUpdate |
— | — |
| 109 | ReleaseBuild | 6: builds.listReleaseBuilds, builds.createReleaseBuild, builds.getReleaseBuild, builds.finalizeReleaseBuild, builds.revokeReleaseBuild, downloads.getVersionDownload |
1: build.revoked.v1 |
— |
| 110 | ReleaseBuildDepot | 2: builds.setReleaseBuildDepot, builds.listReleaseBuildDepots |
— | — |
| 111 | ReleaseChannel | 7: channels.listReleaseChannels, channels.createReleaseChannel, channels.getReleaseChannel, channels.updateReleaseChannel, channels.getDownloadPage, installations.enrolInstallation and 1 more |
— | 4: EntitlementsService.Check, EntitlementsService.StreamSnapshot, UsageService.Reserve, UsageService.Settle |
| 112 | Release (append-only) | 9: webhooks.listWebhookEventTypes, channels.listChannelReleases, channels.stageRelease, channels.rollbackChannel, channels.getRelease, channels.approveRelease and 3 more |
3: release.activated.v1, release.paused.v1, release.rolled_back.v1 |
— |
| 113 | ReleaseChannelAccess (optional) | 4: channels.listChannelAccess, channels.createChannelAccess, channels.deleteChannelAccess, channels.getDownloadPage |
— | — |
| 114 | ReleaseSigningKey | 4: signing.listSigningKeys, signing.createSigningKey, signing.rotateSigningKey, signing.revokeSigningKey |
— | — |
| 115 | ReleaseSignedMetadata (immutable) | 5: channels.approveRelease, signing.rotateSigningKey, signing.listSignedMetadata, signing.getChannelMetadata, signing.getChannelRootVersion |
— | — |
| 116 | ReleaseMetadataSignature | 2: signing.listMetadataSignatures, signing.getChannelMetadata |
— | — |
| 117 | ReleaseEncryptionKey (optional) | 3: signing.listEncryptionKeys, signing.createEncryptionKey, signing.rotateEncryptionKey |
— | — |
| 118 | ReleaseInstallation | 7: sync.redeemEnrolment, installations.enrolInstallation, installations.listInstallations, installations.getInstallationSummary, installations.checkForUpdate, installations.rotateInstallationToken and 1 more |
2: installation.enrolled.v1, installation.updated.v1 |
1: InstallationsService.VerifyInstallation |
| 119 | ReleaseUpdateEvent (optional) | 8: channels.getDownloadPage, downloads.getLatestDownload, downloads.getLatestPlatformDownload, downloads.getVersionDownload, installations.createUpdateEvent, installations.listInstallationUpdateEvents and 2 more |
1: installation.updated.v1 |
— |
| 130 | ReleaseTesterGroup | 6: channels.listTesterGroups, channels.createTesterGroup, channels.updateTesterGroup, channels.attachTesterGroupChannel, channels.detachTesterGroupChannel, channels.getDownloadPage |
— | — |
| 131 | ReleaseTester | 6: channels.listTesters, channels.createTester, channels.revokeTester, channels.getDownloadPage, installations.createTesterVerification, installations.confirmTesterVerification |
— | — |
| 151 | ReleaseInstallerArtifact (immutable) | 4: builds.listReleaseInstallerArtifacts, downloads.getLatestDownload, downloads.getLatestPlatformDownload, downloads.getVersionDownload |
— | — |
Farm: Agent Platform¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 120 | AgentDefinition | 6: agents.listAgents, agents.createAgent, agents.getAgent, agents.updateAgent, agents.setAgentStatus, conversations.createConversation |
1: agent_definition.changed.v1 |
4: CompletionsService.Complete, CompletionsService.Embed, BatchesService.SubmitBatch, BatchesService.GetBatch |
| 121 | AgentModelProfile | 6: completions.listModelCalls, completions.listProviders, agents.listModelProfiles, agents.createModelProfile, agents.updateModelProfile, agents.retireModelProfile |
3: model_call.completed.v1, provider.degraded.v1, agent_model_profile.changed.v1 |
4: CompletionsService.Complete, CompletionsService.Embed, BatchesService.SubmitBatch, BatchesService.GetBatch |
| 122 | AgentTool | 6: staff.listCapabilityCatalogs, agents.listTools, agents.createTool, agents.updateTool, conversations.sendMessage, conversations.confirmToolCall |
— | 5: CatalogService.GetCatalog, EntitlementsService.Check, EntitlementsService.StreamSnapshot, UsageService.Reserve, UsageService.Settle |
| 123 | AgentToolBinding | 5: agents.listAgentTools, agents.bindAgentTool, agents.updateAgentToolBinding, agents.unbindAgentTool, conversations.confirmToolCall |
— | — |
| 124 | AgentConversation | 5: conversations.listConversations, conversations.createConversation, conversations.getConversation, conversations.updateConversation, conversations.archiveConversation |
— | — |
| 125 | AgentMessage (immutable) | 3: completions.listModelCalls, conversations.listMessages, conversations.sendMessage |
1: conversation.turn.completed.v1 |
4: CompletionsService.Complete, CompletionsService.Embed, BatchesService.SubmitBatch, BatchesService.GetBatch |
| 126 | AgentToolCall (immutable) | 3: conversations.listToolCalls, conversations.confirmToolCall, conversations.refuseToolCall |
1: conversation.turn.completed.v1 |
— |
| 127 | AgentConnector (future work) | 1: agents.listConnectors |
— | — |
| 128 | AgentConnectorInstance (future work) | 3: agents.listConnectorInstances, agents.createConnectorInstance, agents.revokeConnectorInstance |
— | — |
Farm: Content And News¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 147 | Article | 8: articles.listArticles, articles.createArticle, articles.getArticle, articles.updateArticle, articles.submitArticle, articles.publishArticle and 2 more |
3: article.published.v1, article.updated.v1, article.unpublished.v1 |
— |
| 148 | ArticleTranslation | 4: articles.createArticle, articles.getArticle, articles.putArticleTranslation, articles.deleteArticleTranslation |
1: article.updated.v1 |
— |
| 149 | NewsAsset | 2: articles.listNewsAssets, articles.createNewsAsset |
— | — |
Farm: Types¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 1000 | Telephone | shared type, referred to by 1 contracts | — | — |
| 1001 | NationalIdentifierType | shared type, referred to by 1 contracts | — | — |
| 1002 | OrganizationRoleCapabilityEnum | 133: organizations.updateOrganization, organizations.requestOrganizationClosure, organizations.cancelOrganizationClosure, organizations.requestCooperativeLink, organizations.acceptCooperativeLink, organizations.rejectCooperativeLink and 127 more |
5: organization.updated.v1, membership.granted.v1, delegation.granted.v1, raw_file.removed.v1, ownership.transferred.v1 |
3: ModelsService.ListModels, ModelsService.Predict, CatalogService.GetCatalog |
| 1003 | IdentifiersValues | 1: animals.listAnimalIdentifiers |
— | — |
| 1004 | Period | shared type, referred to by 9 contracts | — | — |
| 1005 | AnimalSexEnum | shared type, referred to by 2 contracts | — | — |
| 1006 | MoonitoringCapabilityEnum | 181: audit.listAuditEvents, audit.getAuditEvent, organizations.listOrganizations, organizations.countOrganizations, organizations.requestOrganizationClosure, organizations.cancelOrganizationClosure and 175 more |
6: organization_role.updated.v1, model_version.deployed.v1, model_version.retired.v1, entitlement.granted.v1, agent_definition.changed.v1, agent_model_profile.changed.v1 |
3: ModelsService.ListModels, ModelsService.Predict, CatalogService.GetCatalog |
| 1007 | ChunkingParams | 1: builds.createReleaseDepot |
— | — |
| 1008 | ObservationValue | shared type, referred to by 1 contracts | — | — |
| 1009 | ObservationTime | shared type, referred to by 1 contracts | — | — |
| 1010 | EventTime | shared type, referred to by 5 contracts | — | — |
| 1011 | TimePrecisionEnum | shared type, referred to by 1 contracts | — | — |
| 1012 | AggregationEnum | shared type, referred to by 1 contracts | — | — |
| 1013 | CodedValue | shared type, referred to by 6 contracts | — | — |
| 1014 | ParentReference | shared type, referred to by 2 contracts | — | — |
| 1015 | WithdrawalSpec | 1: events.listEventProducts |
— | — |
| 1016 | PropertyDefinition | shared type, referred to by 1 contracts | — | — |
| 1017 | PropertyQualifiers | shared type, referred to by 1 contracts | — | — |
| 1018 | CoverageDetails | shared type, referred to by 1 contracts | — | — |
| 1019 | RecordRevision | 2: events.listEventRevisions, observations.listObservationRevisions |
— | — |
| 1020 | NumericBounds | shared type, referred to by 1 contracts | — | — |
| 1021 | AggregationDetails | shared type, referred to by 1 contracts | — | — |
| 1022 | RecordReference | shared type, referred to by 1 contracts | — | — |
| 1023 | ObservedPeriod | shared type, referred to by 2 contracts | — | — |
| 1024 | SystemVersion | 1: animals.listAnimalHistory |
— | — |
| 1025 | BreedShare | shared type, referred to by 1 contracts | — | — |
| 1028 | OrganizationPredefinedRoleEnum | shared type, referred to by 1 contracts | — | — |
| 1029 | MoonitoringPredefinedRoleEnum | shared type, referred to by 1 contracts | — | — |
Farm: Catalog References¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 1026 | MlDatasetSelection | shared type, referred to by 1 contracts | — | — |
| 1027 | SourceDetection | 1: sync.openSyncRun |
— | — |
| 2000 | MilkAnalysisProfileFamilies (draft proposal) | 1: observations.listObservationTypes |
— | — |
| 2001 | MilkProductionProfiles (draft proposal) | 1: observations.listObservationTypes |
— | — |
| 2002 | CanonicalRecordExamples (illustrative, not source mappings) | — | — | — |
Grants: Funding Call Sources And Collections¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 200 | FundingCallSource | 3: calls.listFundingCallSources, calls.createFundingCallSource, calls.updateFundingCallSource |
— | — |
| 201 | GrantCollection | 3: calls.listGrantCollections, calls.registerGrantCollection, calls.getGrantCollection |
— | — |
Grants: Funding Calls¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 202 | FundingCall | 11: calls.listPublishedCalls, calls.getPublishedCall, calls.listCalls, calls.getCall, calls.holdCall, calls.restoreCallRevision and 5 more |
1: funding_call.published.v1 |
— |
| 203 | SourceDocument | 4: calls.getSourceDocumentUrl, calls.listCallDocuments, calls.registerGrantCollection, calls.resetSourceDocumentText |
— | — |
| 204 | CallDocument | 3: calls.getSourceDocumentUrl, calls.listCallDocuments, calls.registerGrantCollection |
— | — |
Grants: Extraction¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 205 | GrantBatch | 6: calls.listGrantBatches, calls.createGrantBatch, calls.forecastGrantBatch, calls.getGrantBatch, calls.resumeGrantBatch, calls.failGrantBatch |
— | 4: CompletionsService.Complete, CompletionsService.Embed, BatchesService.SubmitBatch, BatchesService.GetBatch |
| 206 | ProviderRequest | 2: calls.createGrantBatch, calls.listProviderRequests |
— | 4: CompletionsService.Complete, CompletionsService.Embed, BatchesService.SubmitBatch, BatchesService.GetBatch |
| 207 | ExtractionRun (immutable) | 4: calls.listCallRevisions, calls.restoreCallRevision, calls.createGrantBatch, calls.listBatchRuns |
— | — |
| 208 | SearchAreaAssignment | 2: calls.listSearchAreaAssignments, calls.createSearchAreaAssignment |
— | — |
| 209 | CallTerritory | 3: calls.getPublishedCall, calls.listCallTerritories, calls.publishBatch |
— | — |
Grants: Places¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 210 | Municipality | 1: calls.searchMunicipalities |
— | — |
| 211 | FarmDirectoryEntry | 1: calls.searchFarmDirectory |
— | — |
Grants: The Farmer'S Research¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 212 | Research | 5: research.getResearch, research.deleteResearch, research.saveResearchFarm, research.saveResearchContact, research.claimResearch |
— | — |
| 213 | ResearchFarm | 3: research.getResearch, research.saveResearchFarm, research.listResults |
— | — |
| 214 | CallAction (append-only) | 2: research.listCallActions, research.recordCallAction |
— | — |
Grants: Farmer Documents And Facts¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 215 | FarmerDocument | 10: documents.listFarmerDocuments, documents.createFarmerDocument, documents.finalizeFarmerDocument, documents.retryFarmerDocument, documents.getFarmerDocument, documents.deleteFarmerDocument and 4 more |
2: farmer_document.uploaded.v1, farmer_document.read.v1 |
— |
| 216 | FarmFact | 2: documents.listFarmFacts, documents.disputeFarmFact |
1: farmer_document.read.v1 |
— |
| 217 | FarmerDocumentProfile | 2: documents.createFarmerDocument, documents.getFarmerDocumentProfile |
1: farmer_document.read.v1 |
— |
| 218 | GrantCheck | 3: documents.getGrantCheck, documents.listGrantChecks, research.listResults |
1: grant_check.changed.v1 |
— |
Grants: The Verified Record (Types)¶
| Req | Entity or type | REST operations | Events | gRPC |
|---|---|---|---|---|
| 1200 | FactKey | 1: documents.listFarmFacts |
— | — |
| 1201 | RequirementOperator | 1: documents.getGrantCheck |
— | — |
| 1202 | Citation | 1: calls.listCallTerritories |
— | — |
| 1203 | RequirementClause | 1: documents.getGrantCheck |
— | — |
| 1204 | RequirementAlternative | 1: documents.getGrantCheck |
— | — |
| 1205 | VerifiedRecord | 1: calls.getPublishedCall |
— | — |
| 1206 | PurposeGroup | 3: calls.listPublishedCalls, research.saveResearchFarm, research.listResults |
— | — |
| 1207 | Species | 1: research.saveResearchFarm |
— | — |
| 1208 | Availability | 2: calls.listPublishedCalls, research.listResults |
— | — |
| 1209 | DocumentKind | 1: documents.createFarmerDocument |
— | — |
| 1210 | DocumentFailureReason | 1: documents.getFarmerDocument |
— | — |
| 1211 | Herd | 1: research.saveResearchFarm |
— | — |
| 1212 | SearchArea | 3: calls.listPublishedCalls, research.listResults, research.countResults |
— | — |