Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for aleph_emit_document operation #232

Open
tillprochaska opened this issue Jul 26, 2023 · 1 comment
Open

Update docs for aleph_emit_document operation #232

tillprochaska opened this issue Jul 26, 2023 · 1 comment

Comments

@tillprochaska
Copy link
Contributor

The list of available metadata properties in the docs seems to be slightly outdated.

I’ve skimmed the code in Memorious, alephclient, and the Aleph API and this should be the latest list of all allowed props: https://github.com/alephdata/aleph/blob/develop/aleph/validation/schema/ingest.yml.

Might be worth only mentioning a few examples of allowed metadata properties in the docs and to link to the YAML file from the Aleph repo so we do not have to update the list in the Memorious docs.

@tillprochaska
Copy link
Contributor Author

I missed a detail: While the metadata items in the file above are what Aleph accepts, the items you can pass from the aleph_emit op in Memorious are actually limited by these two methods: https://github.com/alephdata/memorious/blob/main/memorious/operations/aleph.py#L14-L47

As far as I can see, items supported by the Aleph Ingest API but not in Memorious are:

  • authored_at
  • date
  • generator
  • mime_type
  • summary

It’s all a bit confusing to be honest, because these metadata items also do not always map 1:1 to FtM properties, I guess that is a relict of the fact that documents have been a separate concept (and not entities) in the first versions of Aleph.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant