IRPCDeclarativeMetadataStructure.GenerateDeclarativeMetadataStructureSchema
Administration API / specialized admin session returns metadata structure version
Gets the JSON Schema document that describes the declarative metadata structure format.
| Service | Declarative metadata structure MFiles.IRPCDeclarativeMetadataStructure |
|---|---|
| gRPC method | /MFiles.IRPCDeclarativeMetadataStructure/GenerateDeclarativeMetadataStructureSchema |
| HTTP (mf-http-grpc) | POST /grpc/v1/generate-declarative-metadata-structure-schema |
| Request | GenerateDeclarativeMetadataStructureSchemaRequest |
| Response | GenerateDeclarativeMetadataStructureSchemaResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
- Fails with "Not implemented." unless the feature is enabled on the server.
- Requires
change_metadata_structure. Changes nothing. - Validate a document against this schema locally, or on the server with
SetDeclarativeMetadataStructure
and
dry_run_with_schema_validation.
Request: GenerateDeclarativeMetadataStructureSchemaRequest
No fields.
Response: GenerateDeclarativeMetadataStructureSchemaResponse
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
declmds_schema | string | The JSON Schema of the declarative metadata structure document, as text. |
Related methods
- SetDeclarativeMetadataStructure -- Validates a declarative JSON document against the schema, or converts it for deployment.