Manually populate API Catalog with existing APIs
Closed, ResolvedPublic5 Estimated Story Points
Actions

Assigned To

Authored By

	• sdkim
	Oct 7 2021, 7:29 PM

Description

Acceptance Criteria

For each service, I am able to see the following in API Catalog
- Service Name
- Owner
- Reference documentation
I am able to view backstage on a hosted site (https://backstage-api-catalog.toolforge.org/api-docs?filters%5Bkind%5D=api&filters%5Buser%5D=all)
Enable manual yaml file flow to add net new API to catalog
Enable UI flow to add net new API to catalog
- Documented but not tested
Document how API producers can add APIs to the catalog
- https://wikitech.wikimedia.org/wiki/API_catalog

Related Objects
Search...

Status	Subtype	Assigned	Task
Open		None	T285008 View API Inventory
Resolved		apaskulin	T292780 Manually populate API Catalog with existing APIs
Declined	Spike	apaskulin	T298123 Ensure "Try it Out" button works

Event Timeline

• sdkim created this task.Oct 7 2021, 7:29 PM

• nnikkhoui set the point value for this task to 8.Oct 7 2021, 7:43 PM

Assuming we use Backstage for this, it looks to me like the first step is creating a template (in template.yaml):

https://backstage.io/docs/features/software-templates/adding-templates
https://backstage.io/docs/features/software-templates/writing-templates

Unless Adam's instance already has something suitable set up, we'll want to either allow time for that in our estimate, or else create a separate task for that.

BPirkle added a subscriber: • nnikkhoui.Oct 7 2021, 7:45 PM

• nnikkhoui changed the point value for this task from 8 to 5.Oct 7 2021, 7:51 PM

Adding the list of APIs that @nnikkhoui 's compiled
https://www.mediawiki.org/wiki/Core_Platform_Team/Initiatives/API_Platform/API_list

• sdkim removed • sdkim as the assignee of this task.Oct 19 2021, 3:58 PM

• sdkim updated the task description. (Show Details)Oct 19 2021, 7:37 PM

• sdkim assigned this task to apaskulin.Dec 3 2021, 5:15 PM

Working draft is at User:Alex_Paskulin/API_catalog; meeting with Nikki later this week to discuss strategy

PR is up here https://gitlab.wikimedia.org/nikkin/backstage/-/merge_requests/3

apaskulin moved this task from Backlog to QA/Review on the API Platform board.Dec 17 2021, 7:58 PM

apaskulin moved this task from QA/Review to Backlog on the API Platform board.Dec 22 2021, 7:03 PM

apaskulin updated the task description. (Show Details)

APIs populated in the catalog; process documented at https://wikitech.wikimedia.org/wiki/API_catalog

Moving to signoff instead to comply with the process

• sdkim closed this task as Resolved.Jan 31 2022, 10:26 PM

• sdkim moved this task from Sign-off to Should do next on the API Platform board.

apaskulin closed subtask T298123: Ensure "Try it Out" button works as Declined.Sep 13 2022, 5:16 PM

Manually populate API Catalog with existing APIsClosed, ResolvedPublic5 Estimated Story PointsActions

Description

Related ObjectsSearch...

Event Timeline

Manually populate API Catalog with existing APIs
Closed, ResolvedPublic5 Estimated Story Points
Actions

Related Objects
Search...