You are browsing a read-only backup copy of Wikitech. The live site can be found at wikitech.wikimedia.org

Difference between revisions of "User talk:Alex Paskulin/API catalog"

From Wikitech-static
Jump to navigation Jump to search
imported>Alex Paskulin
(Created page with "== First draft questions == * The [https://backstage.io/docs/features/software-catalog/descriptor-format#speclifecycle-required-1 Backstage docs] list a few values for the lifecycle field. Do we have a list of the values we want to use? The [https://api.wikimedia.org/wiki/Community/API_guidelines#API_Lifecycle API guidelines] have design, develop, deploy, etc., but those seem more like project phases? * The [https://backstage.io/docs/features/software-catalog/descriptor...")
 
imported>Nikki Nikkhoui
(misread one of your questions - clarified my response)
Line 5: Line 5:
* The [https://backstage.io/docs/features/software-catalog/descriptor-format#specowner-required-1 spec.owner field] seems to require an entity to be set up in Backstage. Should we go through and set these up for each team, or is it ok for them to be 404 links? ([https://backstage.toolforge.org/catalog/default/group/platform%20engineering%20team Example])
* The [https://backstage.io/docs/features/software-catalog/descriptor-format#specowner-required-1 spec.owner field] seems to require an entity to be set up in Backstage. Should we go through and set these up for each team, or is it ok for them to be 404 links? ([https://backstage.toolforge.org/catalog/default/group/platform%20engineering%20team Example])
--[[User:Alex Paskulin|Alex Paskulin]] ([[User talk:Alex Paskulin|talk]]) 00:03, 1 December 2021 (UTC)
--[[User:Alex Paskulin|Alex Paskulin]] ([[User talk:Alex Paskulin|talk]]) 00:03, 1 December 2021 (UTC)
:* I actually think the suggested <code>experimental</code>, <code>production</code>, <code>deprecated</code> on Backstage are better terms, my opinion would be to use those 3 if you agree? I don't know if "Lifecycle" on the API guidelines was intended to mean the same thing, it may be worth renaming the API guidelines section.
:* All APIs can have a spec type (if we want to again go with Backstage suggested <code>service</code>, <code>website</code>, or <code>library</code> terms. but for those that may not have a spec definition, we could create a script that will generate a bare-bones default API spec file that can be loaded as the definition. Just enough values to be considered a "valid" OpenAPI spec. What do you think?
:* I think we should definitely set these up for each team! OR....better yet find a way to generate them from some central source...like querying LDAP! [[User:Nikki Nikkhoui|Nikki Nikkhoui]] ([[User talk:Nikki Nikkhoui|talk]]) 23:46, 2 December 2021 (UTC)

Revision as of 23:47, 2 December 2021

First draft questions

  • The Backstage docs list a few values for the lifecycle field. Do we have a list of the values we want to use? The API guidelines have design, develop, deploy, etc., but those seem more like project phases?
  • The Backstage docs list the spec type and definition as required fields. What should we do for APIs without a spec?
  • The spec.owner field seems to require an entity to be set up in Backstage. Should we go through and set these up for each team, or is it ok for them to be 404 links? (Example)

--Alex Paskulin (talk) 00:03, 1 December 2021 (UTC)

  • I actually think the suggested experimental, production, deprecated on Backstage are better terms, my opinion would be to use those 3 if you agree? I don't know if "Lifecycle" on the API guidelines was intended to mean the same thing, it may be worth renaming the API guidelines section.
  • All APIs can have a spec type (if we want to again go with Backstage suggested service, website, or library terms. but for those that may not have a spec definition, we could create a script that will generate a bare-bones default API spec file that can be loaded as the definition. Just enough values to be considered a "valid" OpenAPI spec. What do you think?
  • I think we should definitely set these up for each team! OR....better yet find a way to generate them from some central source...like querying LDAP! Nikki Nikkhoui (talk) 23:46, 2 December 2021 (UTC)