feat: fill in the metadata of resource schema#12224
Merged
moonming merged 8 commits intoMay 29, 2025
Merged
Conversation
bzp2010
changed the title
bzp2010
force-pushed
the
bzp/feat-reorg-resource-metadata
branch
from
May 20, 2025 01:57
57243ae to
386ec6c
Compare
bzp2010
requested review from
AlinsRan,
Revolyssup,
SkyeYoung,
juzhiyuan,
kayx23,
membphis and
nic-6443
May 20, 2025 11:56
bzp2010
marked this pull request as ready for review
May 20, 2025 11:56
dosubot
Bot
added
size:L
juzhiyuan
previously approved these changes
May 20, 2025
nic-6443
previously approved these changes
May 21, 2025
Baoyuantop
reviewed
May 21, 2025
SkyeYoung
previously approved these changes
May 21, 2025
SkyeYoung
left a comment
SkyeYoung
left a comment
Member
There was a problem hiding this comment.
Glad to see this change. This makes APISIX's APIs more user-friendly for the dashboard project.
Baoyuantop
previously approved these changes
May 21, 2025
kayx23
previously approved these changes
May 21, 2025
Co-authored-by: Traky Deng <[email protected]>
bzp2010
dismissed stale reviews from kayx23, Baoyuantop, and SkyeYoung
via
May 21, 2025 06:41
47ba2ac
bzp2010
requested review from
Baoyuantop,
SkyeYoung,
juzhiyuan,
kayx23 and
nic-6443
May 21, 2025 06:41
nic-6443
approved these changes
May 21, 2025
SkyeYoung
approved these changes
May 21, 2025
kayx23
approved these changes
May 21, 2025
laz-xyr
pushed a commit
to laz-xyr/apisix
that referenced
this pull request
Jun 19, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR organizes the resource schema and ensures that resources that are primarily manipulated by users contain a metadata section consisting of
name,desc,labels.This will address some issues in downstream projects such as the new embedded dashboard or the API declarative configuration tool for APISIX (ADC).
desc✅
labels✅
desc✅
labels✅
desc✅
labels✅
nameandidwithusername, which will always have the same value.desc➕
labels✅
desc✅
labels✅
name, and SNI combinations can often represent SSL resources.desc➕
labels✅
desc✅
labels➕
Strictly, this is plugin data and should not be part of the APISIX core resources. When we design a new API to allow plugins to register their own resources, it will be removed and the core resource schema.
It is simply a combination of one or more plugins so that they run globally and therefore do not require metadata fields.
desc✅
labels✅
desc✅
labels✅
desc✅
labels✅
It corresponds one-to-one with each plugin and does not require metadata fields.
It uniquely configures a secret provider using the secret provider and id and requires no additional metadata fields.
Checklist
additionalPropertiesto consumer credential. It is now consistent with the other core resources. I think this is a fix for a historical bug. 🔥🔥🔥