Implement a proposal Api endpoint

added to epic eclipsefdn/it&6 (closed)

assigned to @epoirier

added priorityhigh severitynormal statetodo team:webdev labels

added prioritymedium label and removed priorityhigh label

added MBO label

changed due date to February 17, 2023

We need to implement and deploy this feature in the first half of the quarter to enable @oliviergoulet to implement the front-end updates to enable us to update our project pages to allow sites to opt-in for showing project proposals.

mentioned in issue sdv.eclipse.org#37 (closed)

@cguindon Here is a first draft of what I'm proposing for the project proposals endpoint output. There is a lot more fields in this content type but i'm adding the ones that are categorized as "Basic" in the Edit form and other fields that are showing up on the Overview page of the node.

[
  {
    "project_id": "project_id",
    "name": "Eclipse Name",
    "parent": "Parent Project",
    "top_level_project": "Top Level Project",
    "working_group": [
      {
        "name": "Name",
        "id": "Id"
      }
    ],
    "state": "review",
    "description": "Some text..",
    "scope": "Some text..",
    "background": "Some text..",
    "url": "https://projects.eclipse.org/proposals/path",
    "project_url": "https://projects.eclipse.org/projects/path",
    "spec_project": [
      {
        "name": "Name",
        "id": "Id"
      }
    ],
    "committers": [
      {
        "username": "username",
        "url": "https://api.eclipse.org/account/profile/username"
      }
    ],
    "project_leads": [
      {
        "username": "username",
        "url": "https://api.eclipse.org/account/profile/username"
      }
    ],
    "mentors": [
      {
        "username": "username",
        "url": "https://api.eclipse.org/account/profile/username"
      }
    ],
    "patent_license": "Compatible Patent License",
    "licenses": [
      {
        "name": "License Name",
        "url": "https://projects.eclipse.org/content/apache-license-version-2.0"
      }
    ],
    "repo_type": "gitlab",
    "repos": [
      {
        "url": "https://gitlab.eclipse.org/eclipse/repo/path"
      }
    ]
  }
]

In my next comment, I will propose parameters for this endpoint.

LGTM as a first draft.

@cguindon Here is what I'm proposing to add for the first draft of the parameters for this endpoint.

projects.eclipse.org/api/proposals?working_group=WG&state=STATE&parent=PARENT&top_level_project=TLP

Parameters:

Name: working_group
Type: string
Description: The working group associated to the project.

Name: state
Type: string
Description: The state the project proposal is currently in.

Name: spec_project
Type: string
Description: Wether or not this is a specification project.

Name: spec_project_working_group
Type: string
Description: The specification project working group associated to the project.

Note that at the exception of the state param, i'm adding the same params as for the projects endpoint.

Let me know if we should be adding more.

+1

The proposal endpoint is now available on staging.

https://projects-staging.eclipse.org/api/proposals

Let me know if there's anything else.

Thanks.

@oliviergoulet the Proposal endpoint is now on production.

https://projects.eclipse.org/api/proposals

Please have a look and let me know if you find anything wrong.

Thanks.

closed