From ad4dd1737f2fc10f3a7ad40377ad513fac5c616f Mon Sep 17 00:00:00 2001 From: Uwe Krueger Date: Wed, 24 Aug 2022 17:29:16 +0200 Subject: [PATCH] fix doc --- docs/ocm/model.md | 2 +- docs/ocm/operations.md | 11 ++++++++--- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/ocm/model.md b/docs/ocm/model.md index d55440044..7e5961a1c 100644 --- a/docs/ocm/model.md +++ b/docs/ocm/model.md @@ -401,7 +401,7 @@ global identity triple to the following procedure: [component descriptor](#component-descriptor) by using its component identity and version name in the desired [repository context](#repository-contexts) -- identify the artefact by is local identity (distinguish between [source](#sources) +- identify the artefact by its local [identity](#identity) (distinguish between [source](#sources) and [resource](#resources)) - [apply](operations.md#access-methods) the described [access method](#artefact-access) diff --git a/docs/ocm/operations.md b/docs/ocm/operations.md index d4efaaa20..8800d5b6b 100644 --- a/docs/ocm/operations.md +++ b/docs/ocm/operations.md @@ -97,10 +97,15 @@ according to their [specifications](../formats/accessmethods/README.md). The local access method is mapped to the local blob access provided by the repository. -They have to support read access, only. At least a stream access for the -denoted blob is required. +They have to support read access, only. At least a media type and stream access +for the denoted blob is required. -- **`.GetStream(AccessSpecification) (Byte Stream, error)`** +- **`.GetMediaType(RepositoryContext, ComponentVersion, AccessSpecification) (string, error)`** + + Provide the media type of the described artefact. It might explicitly be stored + as part of the access speficatio, or implicitly provided by the access method. + +- **`.GetStream(RepositoryContext, ComponentVersion, AccessSpecification) (Byte Stream, error)`** Provide access to the blob content described by a dedicated access specification.