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

PB-755: Spec for collection assets #455

Merged
merged 2 commits into from
Sep 9, 2024
Merged

Conversation

benschs
Copy link
Contributor

@benschs benschs commented Sep 4, 2024

Add CRUD endpoints for collection level assets.
Add endpoints for collection asset upload management. As process for upload is the same as for feature assets, only link to description.

@benschs benschs marked this pull request as ready for review September 4, 2024 14:04
Copy link
Contributor

@boecklic boecklic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link

@asteiner-swisstopo asteiner-swisstopo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @benschs,

As discussed, I have had a look and found mostly typos or unclear writing.

The only more important remarks are

  • Should we mention the parallel upload capabilities?
  • Is the response "500" intentional or should it be "5XX"?

Note to myself: openapitransactional.yaml is generated from the other files (responses.yaml, paths.yaml, tags.yaml).

spec/transaction/paths.yaml Outdated Show resolved Hide resolved
spec/transaction/paths.yaml Show resolved Hide resolved
spec/transaction/paths.yaml Outdated Show resolved Hide resolved
spec/transaction/paths.yaml Outdated Show resolved Hide resolved
spec/transaction/paths.yaml Outdated Show resolved Hide resolved
spec/transaction/paths.yaml Outdated Show resolved Hide resolved
spec/transaction/paths.yaml Outdated Show resolved Hide resolved
spec/transaction/paths.yaml Outdated Show resolved Hide resolved
spec/transaction/paths.yaml Outdated Show resolved Hide resolved
spec/transaction/paths.yaml Show resolved Hide resolved
description: |
Collection Asset files are uploaded via the STAC API using the API requests described in this chapter.

The flow of the requests is the same as for assets that belong to features, which is described under [Asset Upload Management](#tag/Asset-Upload-Management)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nothing to do with your PR per se, but I noticed that we tend to use item and feature interchangeably. I found it a bit confusing at first, but maybe there's a good reason? Or maybe there would be value in unifying it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure on the difference, it seems that feature comes from OGC, but STAC uses items. I use them more or less interchangeably.

Add CRUD endpoints for collection level assets.
Add endpoints for collection asset upload management. As process for upload is
the same as for feature assets, only link to description.
@benschs
Copy link
Contributor Author

benschs commented Sep 5, 2024

Hi @benschs,

As discussed, I have had a look and found mostly typos or unclear writing.

The only more important remarks are

* Should we mention the parallel upload capabilities?

* Is the response "500" intentional or should it be "5XX"?

Note to myself: openapitransactional.yaml is generated from the other files (responses.yaml, paths.yaml, tags.yaml).

Thanks for all the feedback, I think I fixed most of the typos.

I added a short sentence about parallel capabilities in the tag description for the multipart upload process.
I also unified the responses to only include "500", although we could even think about removing the 5XX completely from the spec, because AFAICT the user does not gain any information they could act upon.

@asteiner-swisstopo
Copy link

Thanks for all the feedback, I think I fixed most of the typos.

I added a short sentence about parallel capabilities in the tag description for the multipart upload process. I also unified the responses to only include "500", although we could even think about removing the 5XX completely from the spec, because AFAICT the user does not gain any information they could act upon.

Had another look. Most are fixed, some still open. Would you mind having another look please? 😇

@benschs benschs merged commit 1564b11 into develop Sep 9, 2024
3 checks passed
@benschs benschs deleted the feat-PB-755-spec-col-assets branch September 9, 2024 06:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants