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

🛠️ [TASK] : Create API to Retrieve Proposal Templates for Editor #1271

Open
Tracked by #1256
minikin opened this issue Nov 26, 2024 · 0 comments
Open
Tracked by #1256

🛠️ [TASK] : Create API to Retrieve Proposal Templates for Editor #1271

minikin opened this issue Nov 26, 2024 · 0 comments
Labels

Comments

@minikin
Copy link
Collaborator

minikin commented Nov 26, 2024

Description

Rough Draft Endpoints

GET /api/draft/proposal/template/list?id=<Brand/Campaign/Category id>&<optional paging parameters>&type=<PROPOSAL | COMMENT>

id is optional, if not specified, then all proposal templates known are listed, limited by the paging options.
The id are unambiguous, so its possible to tell if whats being requested are all templates being used by a brand, for a brands campaign, or assigned to a category under an event. This is because the id will be a ulid.

This returns a summary list of templates, and their ID's. It is NOT a signed document, just a normal json response.

Proposal Comments are similar to proposals, they are templated the same way, and can be retrieved by setting &type=COMMENT if its not defined, or set to &type=PROPOSAL then only proposal templates can be returned.

NOTE: There will ONLY be a single Proposal and Comment template defined for each unique campaign_id.

Also, template_id can be reused by multiple brands, campaigns and categories.

GET /api/draft/proposal/template/:<template-id>

Returns the template by this ID. :template-id is a ulid, so can not be list and does not conflict with the above.
It MUST be supplied, so can be a path parameter.

The response IS a signed document (Signed by project catalyst) which contains the requested proposal template.

In future, the template would be signed by whoever authored it.

In a decentralized future, the :template_id may change to something more natural for a decentralized document storage reference, if required. It would not look like a ulid, and so should not be a breaking change.

Acceptance Criteria

  • List clear, specific, and measurable criteria for when the task is considered complete.

Resources

  • Add relevant links, documentation, or references.
@minikin minikin changed the title get proposal editor/template 🛠️ [TASK] : Create API to Retrieve Proposal Templates for Editor Nov 26, 2024
@minikin minikin added the F14 label Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: New
Development

No branches or pull requests

1 participant